{
  "id": "@typed/async-data#getSuccess",
  "canonicalId": "@typed/async-data#getSuccess",
  "symbol": {
    "id": "@typed/async-data#getSuccess",
    "packageName": "@typed/async-data",
    "moduleName": ".",
    "exportName": "getSuccess",
    "kind": "function",
    "signatures": [
      "export declare function getSuccess<A, E>(data: AsyncData<A, E>): Option.Option<A>;"
    ],
    "summary": "Returns the current successful or optimistic value as an Effect `Option`.",
    "sections": {
      "Why": "`Option` distinguishes an absent value from a present `undefined` payload and composes with Effect's data APIs.",
      "Ownership and lifetime": "This pure lookup acquires no resources and does not retain the state."
    },
    "examples": [
      {
        "language": "text",
        "code": "```ts\nimport { getSuccess, success } from \"@typed/async-data\"\nconst value = getSuccess(success(1))\n```\nSee [Effect Option](https://effect.website/docs/data-types/option/)."
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/async-data/src/index.ts",
      "line": 858
    },
    "since": "1.0.0",
    "category": "State extraction"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/async-data#getSuccess",
    "packageName": "@typed/async-data",
    "packageVersion": "1.0.0-beta.7",
    "moduleName": ".",
    "consumerSpecifier": "@typed/async-data",
    "exportName": "getSuccess",
    "qualifiedName": "getSuccess",
    "declarationKey": "declaration:f9cc6072a37596f226c6d712",
    "family": "function",
    "signatures": [
      "export declare function getSuccess<A, E>(data: AsyncData<A, E>): Option.Option<A>;"
    ],
    "sourceSpans": [
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 858,
          "column": 1
        },
        "end": {
          "line": 866,
          "column": 2
        }
      }
    ],
    "aliases": [],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:f9cc6072a37596f226c6d712",
    "name": "getSuccess",
    "family": "function",
    "facets": [
      {
        "family": "function",
        "syntaxKind": "FunctionDeclaration",
        "signatures": [
          "export declare function getSuccess<A, E>(data: AsyncData<A, E>): Option.Option<A>;"
        ],
        "typeParameters": [
          "A",
          "E"
        ],
        "sourceSpans": [
          {
            "file": "packages/async-data/src/index.ts",
            "start": {
              "line": 858,
              "column": 1
            },
            "end": {
              "line": 866,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      }
    ],
    "signatures": [
      "export declare function getSuccess<A, E>(data: AsyncData<A, E>): Option.Option<A>;"
    ],
    "typeParameters": [
      "A",
      "E"
    ],
    "summary": "Returns the current successful or optimistic value as an Effect `Option`.",
    "sections": {
      "Why": "`Option` distinguishes an absent value from a present `undefined` payload and composes with Effect's data APIs.",
      "Ownership and lifetime": "This pure lookup acquires no resources and does not retain the state."
    },
    "examples": [
      {
        "language": "text",
        "code": "```ts\nimport { getSuccess, success } from \"@typed/async-data\"\nconst value = getSuccess(success(1))\n```\nSee [Effect Option](https://effect.website/docs/data-types/option/)."
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 858,
          "column": 1
        },
        "end": {
          "line": 866,
          "column": 2
        }
      }
    ],
    "since": "1.0.0",
    "category": "State extraction"
  }
}
