{
  "id": "@typed/fx#Sink.Sink",
  "canonicalId": "@typed/fx/Sink#Sink",
  "symbol": {
    "id": "@typed/fx#Sink.Sink",
    "packageName": "@typed/fx",
    "moduleName": ".",
    "exportName": "Sink.Sink",
    "kind": "interface",
    "signatures": [
      "export interface Sink<A, E = never, R = never> {\n    readonly onSuccess: (value: A) => Effect<unknown, never, R>;\n    readonly onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>;\n}",
      "export declare namespace Sink {\n    type Any = Sink<any, any, any>;\n    type Success<T> = T extends Sink<infer _A, infer _E, infer _R> ? _A : never;\n    type Error<T> = T extends Sink<infer _A, infer _E, infer _R> ? _E : never;\n    type Services<T> = T extends Sink<infer _A, infer _E, infer _R> ? _R : never;\n    interface Service<Self, Id extends string, A, E> extends Sink<A, E, Self> {\n        readonly id: Id;\n        readonly service: Context.Service<Self, Sink<A, E>>;\n        readonly make: <R = never>(onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>, onSuccess: (value: A) => Effect<unknown, never, R>) => Layer<Self, never, Exclude<R, Scope>>;\n    }\n    interface Class<Self, Id extends string, A, E> extends Service<Self, Id, A, E> {\n        new (): Service<Self, Id, A, E>;\n    }\n}"
    ],
    "summary": "Consumes pushed successes and failures through effectful callbacks.",
    "sections": {
      "Why": "`Sink` gives an `Fx` producer one uniform destination while retaining Effect's typed service\nrequirements and complete failure `Cause`. Callback Effects have no typed failure channel, but\nthey may still defect or be interrupted. Handling an incoming Cause is the consumer's policy;\naccepting it successfully does not mean the failed producer operation succeeded.",
      "Ownership and lifetime": "A sink is inert until a producer invokes one of its callbacks. The producer's fiber controls\nordering, interruption, and callback lifetime; services in `R` must be available when callbacks\nrun. `Sink` itself acquires no resources.",
      "Property: onFailure": "Handles the producer's complete typed failure, defect, or interruption cause.",
      "Property: onFailure: Why": "Accepting `Cause` retains information that would be lost by an error-only callback.",
      "Property: onFailure: Ownership and lifetime": "The invoking producer owns ordering and interruption. The returned Effect acquires and releases\nany resources according to its own services and Scope.",
      "Property: onSuccess": "Handles one successful value.",
      "Property: onSuccess: Why": "The success callback is the value-side consumer boundary used by Fx producers.",
      "Property: onSuccess: Ownership and lifetime": "The invoking producer owns ordering and interruption. The returned Effect acquires and releases\nany resources according to its own services and Scope."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { Effect } from \"effect\"\nimport * as Sink from \"@typed/fx/Sink\"\n\nconst logger: Sink.Sink<number, string> = Sink.make(\n  (cause) => Effect.logError(cause),\n  (value) => Effect.log(`received ${value}`)\n)"
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/fx/src/Sink/Sink.ts",
      "line": 39
    },
    "since": "1.0.0",
    "category": "Consumer contracts"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/fx#Sink.Sink",
    "packageName": "@typed/fx",
    "packageVersion": "2.0.0-beta.7",
    "moduleName": ".",
    "consumerSpecifier": "@typed/fx",
    "exportName": "Sink",
    "qualifiedName": "Sink.Sink",
    "declarationKey": "declaration:c25e6ac4cdda592181c35ea0",
    "family": "interface",
    "signatures": [
      "export interface Sink<A, E = never, R = never> {\n    readonly onSuccess: (value: A) => Effect<unknown, never, R>;\n    readonly onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>;\n}",
      "export declare namespace Sink {\n    type Any = Sink<any, any, any>;\n    type Success<T> = T extends Sink<infer _A, infer _E, infer _R> ? _A : never;\n    type Error<T> = T extends Sink<infer _A, infer _E, infer _R> ? _E : never;\n    type Services<T> = T extends Sink<infer _A, infer _E, infer _R> ? _R : never;\n    interface Service<Self, Id extends string, A, E> extends Sink<A, E, Self> {\n        readonly id: Id;\n        readonly service: Context.Service<Self, Sink<A, E>>;\n        readonly make: <R = never>(onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>, onSuccess: (value: A) => Effect<unknown, never, R>) => Layer<Self, never, Exclude<R, Scope>>;\n    }\n    interface Class<Self, Id extends string, A, E> extends Service<Self, Id, A, E> {\n        new (): Service<Self, Id, A, E>;\n    }\n}"
    ],
    "sourceSpans": [
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 39,
          "column": 1
        },
        "end": {
          "line": 70,
          "column": 2
        }
      },
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 72,
          "column": 1
        },
        "end": {
          "line": 238,
          "column": 2
        }
      },
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 319,
          "column": 1
        },
        "end": {
          "line": 470,
          "column": 2
        }
      },
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 69,
          "column": 3
        },
        "end": {
          "line": 69,
          "column": 76
        }
      },
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 54,
          "column": 3
        },
        "end": {
          "line": 54,
          "column": 63
        }
      }
    ],
    "aliases": [
      "@typed/fx/Sink#Sink"
    ],
    "isAlias": true,
    "parentId": "@typed/fx#Sink",
    "static": false,
    "importedFrom": "declaration:c25e6ac4cdda592181c35ea0"
  },
  "declaration": {
    "declarationKey": "declaration:c25e6ac4cdda592181c35ea0",
    "name": "Sink",
    "family": "interface",
    "facets": [
      {
        "family": "interface",
        "syntaxKind": "InterfaceDeclaration",
        "signatures": [
          "export interface Sink<A, E = never, R = never> {\n    readonly onSuccess: (value: A) => Effect<unknown, never, R>;\n    readonly onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>;\n}"
        ],
        "typeParameters": [
          "A",
          "E = never",
          "R = never"
        ],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Sink/Sink.ts",
            "start": {
              "line": 39,
              "column": 1
            },
            "end": {
              "line": 70,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      },
      {
        "family": "namespace",
        "syntaxKind": "ModuleDeclaration",
        "signatures": [
          "export declare namespace Sink {\n    type Any = Sink<any, any, any>;\n    type Success<T> = T extends Sink<infer _A, infer _E, infer _R> ? _A : never;\n    type Error<T> = T extends Sink<infer _A, infer _E, infer _R> ? _E : never;\n    type Services<T> = T extends Sink<infer _A, infer _E, infer _R> ? _R : never;\n    interface Service<Self, Id extends string, A, E> extends Sink<A, E, Self> {\n        readonly id: Id;\n        readonly service: Context.Service<Self, Sink<A, E>>;\n        readonly make: <R = never>(onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>, onSuccess: (value: A) => Effect<unknown, never, R>) => Layer<Self, never, Exclude<R, Scope>>;\n    }\n    interface Class<Self, Id extends string, A, E> extends Service<Self, Id, A, E> {\n        new (): Service<Self, Id, A, E>;\n    }\n}"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Sink/Sink.ts",
            "start": {
              "line": 72,
              "column": 1
            },
            "end": {
              "line": 238,
              "column": 2
            }
          },
          {
            "file": "packages/fx/src/Sink/Sink.ts",
            "start": {
              "line": 319,
              "column": 1
            },
            "end": {
              "line": 470,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Sink/Sink.ts",
            "start": {
              "line": 69,
              "column": 3
            },
            "end": {
              "line": 69,
              "column": 76
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": false
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly onSuccess: (value: A) => Effect<unknown, never, R>;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Sink/Sink.ts",
            "start": {
              "line": 54,
              "column": 3
            },
            "end": {
              "line": 54,
              "column": 63
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": false
      }
    ],
    "signatures": [
      "export interface Sink<A, E = never, R = never> {\n    readonly onSuccess: (value: A) => Effect<unknown, never, R>;\n    readonly onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>;\n}",
      "export declare namespace Sink {\n    type Any = Sink<any, any, any>;\n    type Success<T> = T extends Sink<infer _A, infer _E, infer _R> ? _A : never;\n    type Error<T> = T extends Sink<infer _A, infer _E, infer _R> ? _E : never;\n    type Services<T> = T extends Sink<infer _A, infer _E, infer _R> ? _R : never;\n    interface Service<Self, Id extends string, A, E> extends Sink<A, E, Self> {\n        readonly id: Id;\n        readonly service: Context.Service<Self, Sink<A, E>>;\n        readonly make: <R = never>(onFailure: (cause: Cause.Cause<E>) => Effect<unknown, never, R>, onSuccess: (value: A) => Effect<unknown, never, R>) => Layer<Self, never, Exclude<R, Scope>>;\n    }\n    interface Class<Self, Id extends string, A, E> extends Service<Self, Id, A, E> {\n        new (): Service<Self, Id, A, E>;\n    }\n}"
    ],
    "typeParameters": [
      "A",
      "E = never",
      "R = never"
    ],
    "summary": "Consumes pushed successes and failures through effectful callbacks.",
    "sections": {
      "Why": "`Sink` gives an `Fx` producer one uniform destination while retaining Effect's typed service\nrequirements and complete failure `Cause`. Callback Effects have no typed failure channel, but\nthey may still defect or be interrupted. Handling an incoming Cause is the consumer's policy;\naccepting it successfully does not mean the failed producer operation succeeded.",
      "Ownership and lifetime": "A sink is inert until a producer invokes one of its callbacks. The producer's fiber controls\nordering, interruption, and callback lifetime; services in `R` must be available when callbacks\nrun. `Sink` itself acquires no resources.",
      "Property: onFailure": "Handles the producer's complete typed failure, defect, or interruption cause.",
      "Property: onFailure: Why": "Accepting `Cause` retains information that would be lost by an error-only callback.",
      "Property: onFailure: Ownership and lifetime": "The invoking producer owns ordering and interruption. The returned Effect acquires and releases\nany resources according to its own services and Scope.",
      "Property: onSuccess": "Handles one successful value.",
      "Property: onSuccess: Why": "The success callback is the value-side consumer boundary used by Fx producers.",
      "Property: onSuccess: Ownership and lifetime": "The invoking producer owns ordering and interruption. The returned Effect acquires and releases\nany resources according to its own services and Scope."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { Effect } from \"effect\"\nimport * as Sink from \"@typed/fx/Sink\"\n\nconst logger: Sink.Sink<number, string> = Sink.make(\n  (cause) => Effect.logError(cause),\n  (value) => Effect.log(`received ${value}`)\n)"
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 39,
          "column": 1
        },
        "end": {
          "line": 70,
          "column": 2
        }
      },
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 72,
          "column": 1
        },
        "end": {
          "line": 238,
          "column": 2
        }
      },
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 319,
          "column": 1
        },
        "end": {
          "line": 470,
          "column": 2
        }
      },
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 69,
          "column": 3
        },
        "end": {
          "line": 69,
          "column": 76
        }
      },
      {
        "file": "packages/fx/src/Sink/Sink.ts",
        "start": {
          "line": 54,
          "column": 3
        },
        "end": {
          "line": 54,
          "column": 63
        }
      }
    ],
    "since": "1.0.0",
    "category": "Consumer contracts"
  }
}