{
  "id": "@typed/async-data#Success",
  "canonicalId": "@typed/async-data#Success",
  "symbol": {
    "id": "@typed/async-data#Success",
    "packageName": "@typed/async-data",
    "moduleName": ".",
    "exportName": "Success",
    "kind": "interface",
    "signatures": [
      "export interface Success<A> {\n    readonly _tag: \"Success\";\n    readonly value: A;\n    readonly progress?: Progress | undefined;\n}"
    ],
    "summary": "Represents a successfully produced value, optionally while it refreshes.",
    "sections": {
      "Why": "Success keeps the last usable value available while progress can describe newer work.",
      "Ownership and lifetime": "This plain wrapper acquires no resources; ownership of `value` remains with the caller and `readonly` does not freeze either object.",
      "Property: _tag": "The discriminant for a successful value.",
      "Property: _tag: Why": "The literal tag enables exhaustive success handling without inspecting the payload.",
      "Property: _tag: Ownership and lifetime": "Inherits the resource-free lifetime of its enclosing state.",
      "Property: progress": "Optional progress for a refresh of the successful value.",
      "Property: progress: Why": "Its presence distinguishes refreshing success from a settled success.",
      "Property: progress: Ownership and lifetime": "Inherits the resource-free lifetime of its enclosing state.",
      "Property: value": "The most recently successful value.",
      "Property: value: Why": "The payload remains directly accessible even when `progress` marks a refresh.",
      "Property: value: Ownership and lifetime": "Inherits the enclosing state's lifetime; the caller retains ownership of the referenced value."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { success } from \"@typed/async-data\"\nconst state = success({ id: 1 })"
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/async-data/src/index.ts",
      "line": 138
    },
    "since": "1.0.0",
    "category": "State models"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/async-data#Success",
    "packageName": "@typed/async-data",
    "packageVersion": "1.0.0-beta.13",
    "moduleName": ".",
    "consumerSpecifier": "@typed/async-data",
    "exportName": "Success",
    "qualifiedName": "Success",
    "declarationKey": "declaration:4d537976f06ffa705c6b4449",
    "family": "interface",
    "signatures": [
      "export interface Success<A> {\n    readonly _tag: \"Success\";\n    readonly value: A;\n    readonly progress?: Progress | undefined;\n}"
    ],
    "sourceSpans": [
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 138,
          "column": 1
        },
        "end": {
          "line": 172,
          "column": 2
        }
      },
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 149,
          "column": 3
        },
        "end": {
          "line": 149,
          "column": 28
        }
      },
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 171,
          "column": 3
        },
        "end": {
          "line": 171,
          "column": 44
        }
      },
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 160,
          "column": 3
        },
        "end": {
          "line": 160,
          "column": 21
        }
      }
    ],
    "aliases": [],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:4d537976f06ffa705c6b4449",
    "name": "Success",
    "family": "interface",
    "facets": [
      {
        "family": "interface",
        "syntaxKind": "InterfaceDeclaration",
        "signatures": [
          "export interface Success<A> {\n    readonly _tag: \"Success\";\n    readonly value: A;\n    readonly progress?: Progress | undefined;\n}"
        ],
        "typeParameters": [
          "A"
        ],
        "sourceSpans": [
          {
            "file": "packages/async-data/src/index.ts",
            "start": {
              "line": 138,
              "column": 1
            },
            "end": {
              "line": 172,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly _tag: \"Success\";"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/async-data/src/index.ts",
            "start": {
              "line": 149,
              "column": 3
            },
            "end": {
              "line": 149,
              "column": 28
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": false
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly progress?: Progress | undefined;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/async-data/src/index.ts",
            "start": {
              "line": 171,
              "column": 3
            },
            "end": {
              "line": 171,
              "column": 44
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": true
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly value: A;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/async-data/src/index.ts",
            "start": {
              "line": 160,
              "column": 3
            },
            "end": {
              "line": 160,
              "column": 21
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": false
      }
    ],
    "signatures": [
      "export interface Success<A> {\n    readonly _tag: \"Success\";\n    readonly value: A;\n    readonly progress?: Progress | undefined;\n}"
    ],
    "typeParameters": [
      "A"
    ],
    "summary": "Represents a successfully produced value, optionally while it refreshes.",
    "sections": {
      "Why": "Success keeps the last usable value available while progress can describe newer work.",
      "Ownership and lifetime": "This plain wrapper acquires no resources; ownership of `value` remains with the caller and `readonly` does not freeze either object.",
      "Property: _tag": "The discriminant for a successful value.",
      "Property: _tag: Why": "The literal tag enables exhaustive success handling without inspecting the payload.",
      "Property: _tag: Ownership and lifetime": "Inherits the resource-free lifetime of its enclosing state.",
      "Property: progress": "Optional progress for a refresh of the successful value.",
      "Property: progress: Why": "Its presence distinguishes refreshing success from a settled success.",
      "Property: progress: Ownership and lifetime": "Inherits the resource-free lifetime of its enclosing state.",
      "Property: value": "The most recently successful value.",
      "Property: value: Why": "The payload remains directly accessible even when `progress` marks a refresh.",
      "Property: value: Ownership and lifetime": "Inherits the enclosing state's lifetime; the caller retains ownership of the referenced value."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import { success } from \"@typed/async-data\"\nconst state = success({ id: 1 })"
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 138,
          "column": 1
        },
        "end": {
          "line": 172,
          "column": 2
        }
      },
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 149,
          "column": 3
        },
        "end": {
          "line": 149,
          "column": 28
        }
      },
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 171,
          "column": 3
        },
        "end": {
          "line": 171,
          "column": 44
        }
      },
      {
        "file": "packages/async-data/src/index.ts",
        "start": {
          "line": 160,
          "column": 3
        },
        "end": {
          "line": 160,
          "column": 21
        }
      }
    ],
    "since": "1.0.0",
    "category": "State models"
  }
}