{
  "id": "@typed/fx#Fx.until",
  "canonicalId": "@typed/fx/Fx#until",
  "symbol": {
    "id": "@typed/fx#Fx.until",
    "packageName": "@typed/fx",
    "moduleName": ".",
    "exportName": "Fx.until",
    "kind": "constant",
    "signatures": [
      "export declare const until: {\n    <B, E2, R2>(signal: Fx<B, E2, R2>): <A, E, R>(events: Fx<A, E, R>) => Fx<A, E | E2, R | R2>;\n    <A, E, R, B, E2, R2>(events: Fx<A, E, R>, signal: Fx<B, E2, R2>): Fx<A, E | E2, R | R2>;\n};"
    ],
    "summary": "Forwards `events` until `signal` emits, then interrupts `events`.",
    "sections": {
      "Why": "`until` gives an event source an external stop boundary. Event values retain their order until\nthe first signal; the signal itself is not emitted and the event run then completes by interruption.",
      "Ownership and lifetime": "Both sources start behind one gate in a private Scope. Event completion cancels the signal;\nsignaling cancels events; failures are forwarded unless they are the expected cancellation."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { Fx } from \"@typed/fx\"\nconst bounded = Fx.until(Fx.fromIterable([1, 2, 3]), Fx.succeed(\"stop\"))"
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/fx/src/Fx/combinators/until.ts",
      "line": 29
    },
    "since": "1.0.0",
    "category": "Time and rate"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/fx#Fx.until",
    "packageName": "@typed/fx",
    "packageVersion": "2.0.0-beta.7",
    "moduleName": ".",
    "consumerSpecifier": "@typed/fx",
    "exportName": "Fx",
    "qualifiedName": "Fx.until",
    "declarationKey": "declaration:1b33ed30ded7361632207e83",
    "family": "variable",
    "signatures": [
      "export declare const until: {\n    <B, E2, R2>(signal: Fx<B, E2, R2>): <A, E, R>(events: Fx<A, E, R>) => Fx<A, E | E2, R | R2>;\n    <A, E, R, B, E2, R2>(events: Fx<A, E, R>, signal: Fx<B, E2, R2>): Fx<A, E | E2, R | R2>;\n};"
    ],
    "sourceSpans": [
      {
        "file": "packages/fx/src/Fx/combinators/until.ts",
        "start": {
          "line": 29,
          "column": 14
        },
        "end": {
          "line": 98,
          "column": 2
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/until.ts",
        "start": {
          "line": 30,
          "column": 3
        },
        "end": {
          "line": 30,
          "column": 95
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/until.ts",
        "start": {
          "line": 31,
          "column": 3
        },
        "end": {
          "line": 31,
          "column": 91
        }
      }
    ],
    "aliases": [
      "@typed/fx/Fx#until"
    ],
    "isAlias": true,
    "parentId": "@typed/fx#Fx",
    "static": false,
    "importedFrom": "declaration:1b33ed30ded7361632207e83"
  },
  "declaration": {
    "declarationKey": "declaration:1b33ed30ded7361632207e83",
    "name": "until",
    "family": "variable",
    "facets": [
      {
        "family": "variable",
        "syntaxKind": "VariableDeclaration",
        "signatures": [
          "export declare const until: {\n    <B, E2, R2>(signal: Fx<B, E2, R2>): <A, E, R>(events: Fx<A, E, R>) => Fx<A, E | E2, R | R2>;\n    <A, E, R, B, E2, R2>(events: Fx<A, E, R>, signal: Fx<B, E2, R2>): Fx<A, E | E2, R | R2>;\n};"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Fx/combinators/until.ts",
            "start": {
              "line": 29,
              "column": 14
            },
            "end": {
              "line": 98,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      },
      {
        "family": "call-signature",
        "syntaxKind": "CallSignature",
        "signatures": [
          "<B, E2, R2>(signal: Fx<B, E2, R2>): <A, E, R>(events: Fx<A, E, R>) => Fx<A, E | E2, R | R2>;",
          "<A, E, R, B, E2, R2>(events: Fx<A, E, R>, signal: Fx<B, E2, R2>): Fx<A, E | E2, R | R2>;"
        ],
        "typeParameters": [
          "B",
          "E2",
          "R2",
          "A",
          "E",
          "R"
        ],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Fx/combinators/until.ts",
            "start": {
              "line": 30,
              "column": 3
            },
            "end": {
              "line": 30,
              "column": 95
            }
          },
          {
            "file": "packages/fx/src/Fx/combinators/until.ts",
            "start": {
              "line": 31,
              "column": 3
            },
            "end": {
              "line": 31,
              "column": 91
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      }
    ],
    "signatures": [
      "export declare const until: {\n    <B, E2, R2>(signal: Fx<B, E2, R2>): <A, E, R>(events: Fx<A, E, R>) => Fx<A, E | E2, R | R2>;\n    <A, E, R, B, E2, R2>(events: Fx<A, E, R>, signal: Fx<B, E2, R2>): Fx<A, E | E2, R | R2>;\n};"
    ],
    "typeParameters": [
      "B",
      "E2",
      "R2",
      "A",
      "E",
      "R"
    ],
    "summary": "Forwards `events` until `signal` emits, then interrupts `events`.",
    "sections": {
      "Why": "`until` gives an event source an external stop boundary. Event values retain their order until\nthe first signal; the signal itself is not emitted and the event run then completes by interruption.",
      "Ownership and lifetime": "Both sources start behind one gate in a private Scope. Event completion cancels the signal;\nsignaling cancels events; failures are forwarded unless they are the expected cancellation."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { Fx } from \"@typed/fx\"\nconst bounded = Fx.until(Fx.fromIterable([1, 2, 3]), Fx.succeed(\"stop\"))"
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/fx/src/Fx/combinators/until.ts",
        "start": {
          "line": 29,
          "column": 14
        },
        "end": {
          "line": 98,
          "column": 2
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/until.ts",
        "start": {
          "line": 30,
          "column": 3
        },
        "end": {
          "line": 30,
          "column": 95
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/until.ts",
        "start": {
          "line": 31,
          "column": 3
        },
        "end": {
          "line": 31,
          "column": 91
        }
      }
    ],
    "since": "1.0.0",
    "category": "Time and rate"
  }
}