{
  "id": "@typed/fx/Fx#fromSchedule",
  "canonicalId": "@typed/fx/Fx#fromSchedule",
  "symbol": {
    "id": "@typed/fx/Fx#fromSchedule",
    "packageName": "@typed/fx",
    "moduleName": "Fx",
    "exportName": "fromSchedule",
    "kind": "constant",
    "signatures": [
      "export declare const fromSchedule: <Error, Env>(schedule: Schedule<unknown, unknown, Error, Env>) => Fx<void, Error, Env>;"
    ],
    "summary": "Creates an Fx that emits values according to a Schedule.\nThe Fx emits `void` each time the schedule fires.",
    "sections": {
      "Why": "Effect [Schedule](https://effect.website/docs/v4/api/effect/Schedule) values already\nencode recurrence, delay, and typed schedule failures. `fromSchedule` exposes\nthose decisions as producer-driven ticks without another timing model. The\nschedule governs all ticks: `Schedule.recurs(2)` emits twice here. In contrast,\n`repeat(source, Schedule.recurs(2))` runs an initial source plus two repeats.",
      "Ownership and lifetime": "Construction starts no clock. Running the `Fx` repeatedly invokes the sink under\nthe schedule and completes when the schedule completes. Schedule failures are\nforwarded as causes; interruption cancels waiting and stops further ticks. The\nreturned `Fx` retains the schedule's `Error` and `Env` channels."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { Schedule } from \"effect\"\nimport { collectAll, fromSchedule } from \"@typed/fx/Fx\"\n\nconst twoTicks = fromSchedule(Schedule.recurs(2))\nconst program = collectAll(twoTicks) // [undefined, undefined]"
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/fx/src/Fx/constructors/fromSchedule.ts",
      "line": 40
    },
    "since": "1.0.0",
    "category": "Time and rate"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/fx/Fx#fromSchedule",
    "packageName": "@typed/fx",
    "packageVersion": "2.0.0-beta.13",
    "moduleName": "Fx",
    "consumerSpecifier": "@typed/fx/Fx",
    "exportName": "fromSchedule",
    "qualifiedName": "fromSchedule",
    "declarationKey": "declaration:b2827d7969d34445c386a55f",
    "family": "variable",
    "signatures": [
      "export declare const fromSchedule: <Error, Env>(schedule: Schedule<unknown, unknown, Error, Env>) => Fx<void, Error, Env>;"
    ],
    "sourceSpans": [
      {
        "file": "packages/fx/src/Fx/constructors/fromSchedule.ts",
        "start": {
          "line": 40,
          "column": 14
        },
        "end": {
          "line": 45,
          "column": 4
        }
      }
    ],
    "aliases": [
      "@typed/fx#Fx.fromSchedule"
    ],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:b2827d7969d34445c386a55f",
    "name": "fromSchedule",
    "family": "variable",
    "facets": [
      {
        "family": "variable",
        "syntaxKind": "VariableDeclaration",
        "signatures": [
          "export declare const fromSchedule: <Error, Env>(schedule: Schedule<unknown, unknown, Error, Env>) => Fx<void, Error, Env>;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Fx/constructors/fromSchedule.ts",
            "start": {
              "line": 40,
              "column": 14
            },
            "end": {
              "line": 45,
              "column": 4
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      }
    ],
    "signatures": [
      "export declare const fromSchedule: <Error, Env>(schedule: Schedule<unknown, unknown, Error, Env>) => Fx<void, Error, Env>;"
    ],
    "typeParameters": [],
    "summary": "Creates an Fx that emits values according to a Schedule.\nThe Fx emits `void` each time the schedule fires.",
    "sections": {
      "Why": "Effect [Schedule](https://effect.website/docs/v4/api/effect/Schedule) values already\nencode recurrence, delay, and typed schedule failures. `fromSchedule` exposes\nthose decisions as producer-driven ticks without another timing model. The\nschedule governs all ticks: `Schedule.recurs(2)` emits twice here. In contrast,\n`repeat(source, Schedule.recurs(2))` runs an initial source plus two repeats.",
      "Ownership and lifetime": "Construction starts no clock. Running the `Fx` repeatedly invokes the sink under\nthe schedule and completes when the schedule completes. Schedule failures are\nforwarded as causes; interruption cancels waiting and stops further ticks. The\nreturned `Fx` retains the schedule's `Error` and `Env` channels."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { Schedule } from \"effect\"\nimport { collectAll, fromSchedule } from \"@typed/fx/Fx\"\n\nconst twoTicks = fromSchedule(Schedule.recurs(2))\nconst program = collectAll(twoTicks) // [undefined, undefined]"
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/fx/src/Fx/constructors/fromSchedule.ts",
        "start": {
          "line": 40,
          "column": 14
        },
        "end": {
          "line": 45,
          "column": 4
        }
      }
    ],
    "since": "1.0.0",
    "category": "Time and rate"
  }
}
