@fns-run/fns@0.2.0

Built and signed on GitHub Actions

Built and signed on GitHub Actions

About

Website - Discord - Documentation

⚠ Warning
Fns is currently in the early stages of development and is not yet ready for daily use. Please do not use it in production environments.

Fns SDK is a serverless stateless durable function design pattern. Works with any framework and platform.

Key Features

• Infinite Loop: Run durable function for an infinite amount of time with auto snapshot.
• Scalability: Scale your durable function to infinity, the only limit is your provider.
• Serverless: No need to manage servers or infrastructure.
• Signals & Queries: Trigger signals or query to other functions.
• Mutexes: Solve race conditions at scale with intuitively.
• Awaitable: Await for the result of a function or signal.

Example

fns.createFunction(
  { name: "helloworld", version: 1 },
  ({ useState, useSignal }) => {
    const [name, setName] = useState<string>("name", "John Travolta");
    useSignal<string>("setName", (newName) => setName(newName));

    return async ({ step }) => {
      const firstName = await step.run(
        "set-firstname",
        async () =>
          await fetch("https://api.namefake.com/")
            .then((res) => res.json())
            .then((res) => res.name),
      );
      await step.sleep("wait-10s-then-finish", "5s");
      const lastName = await step.run(
        "set-lastname-Fernandes",
        async () =>
          await fetch("https://api.namefake.com/")
            .then((res) => res.json())
            .then((res) => res.name),
      );

      return `Hello ${firstName} ${lastName}`;
    };
  },
);

fns.createFunction(
  { name: "LockerBox", version: 1 },
  ({ useSignal, useQuery, useState }) => {
    const [locked, setLocked] = useState<boolean>("isLocked", true);
    useSignal("unlock", () => setLocked(false));
    useQuery("isLocked", () => locked());
    return async ({ step, ctx }) => {
      const data = ctx.data as { isLocked: boolean };
      if (data && data.isLocked !== undefined) {
        setLocked(data.isLocked);
      }
      await step.condition("wait-unlock", () => locked() === false);
      return "unlocked";
    };
  },
);

License

The Fns SDK and its integrations are licensed under the Apache-2 License.

The full text of the license can be accessed via this link and is also included in the LICENSE.md file of this software package.