{
  "id": "@typed/fx/Fx#ThrottleOptions",
  "canonicalId": "@typed/fx/Fx#ThrottleOptions",
  "symbol": {
    "id": "@typed/fx/Fx#ThrottleOptions",
    "packageName": "@typed/fx",
    "moduleName": "Fx",
    "exportName": "ThrottleOptions",
    "kind": "type",
    "signatures": [
      "export type ThrottleOptions = {\n    readonly duration: Duration.Input;\n    readonly leading?: boolean | undefined;\n    readonly trailing?: boolean | undefined;\n};"
    ],
    "summary": "Options for {@link throttle}. A duration-only call is leading-edge\n(`{ leading: true, trailing: false }`).",
    "sections": {
      "Why": "Leading and trailing edges answer different interaction needs, so the\nwindow policy is explicit rather than hidden behind separate operators.",
      "Ownership and lifetime": "This immutable value owns no resource. `throttle` reads it when constructing\nthe Fx; the resulting subscription owns the timer and pending value."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import type { ThrottleOptions } from \"@typed/fx/Fx\"\n\nconst options: ThrottleOptions = {\n  duration: \"250 millis\",\n  leading: true,\n  trailing: true\n}"
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/fx/src/Fx/combinators/throttle.ts",
      "line": 42
    },
    "since": "1.0.0",
    "category": "Operator options"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/fx/Fx#ThrottleOptions",
    "packageName": "@typed/fx",
    "packageVersion": "2.0.0-beta.13",
    "moduleName": "Fx",
    "consumerSpecifier": "@typed/fx/Fx",
    "exportName": "ThrottleOptions",
    "qualifiedName": "ThrottleOptions",
    "declarationKey": "declaration:211d2fbfb4f229661c620e50",
    "family": "type-alias",
    "signatures": [
      "export type ThrottleOptions = {\n    readonly duration: Duration.Input;\n    readonly leading?: boolean | undefined;\n    readonly trailing?: boolean | undefined;\n};"
    ],
    "sourceSpans": [
      {
        "file": "packages/fx/src/Fx/combinators/throttle.ts",
        "start": {
          "line": 42,
          "column": 1
        },
        "end": {
          "line": 46,
          "column": 3
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/throttle.ts",
        "start": {
          "line": 43,
          "column": 3
        },
        "end": {
          "line": 43,
          "column": 37
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/throttle.ts",
        "start": {
          "line": 44,
          "column": 3
        },
        "end": {
          "line": 44,
          "column": 42
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/throttle.ts",
        "start": {
          "line": 45,
          "column": 3
        },
        "end": {
          "line": 45,
          "column": 43
        }
      }
    ],
    "aliases": [
      "@typed/fx#Fx.ThrottleOptions"
    ],
    "isAlias": false,
    "static": false
  },
  "declaration": {
    "declarationKey": "declaration:211d2fbfb4f229661c620e50",
    "name": "ThrottleOptions",
    "family": "type-alias",
    "facets": [
      {
        "family": "type-alias",
        "syntaxKind": "TypeAliasDeclaration",
        "signatures": [
          "export type ThrottleOptions = {\n    readonly duration: Duration.Input;\n    readonly leading?: boolean | undefined;\n    readonly trailing?: boolean | undefined;\n};"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Fx/combinators/throttle.ts",
            "start": {
              "line": 42,
              "column": 1
            },
            "end": {
              "line": 46,
              "column": 3
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly duration: Duration.Input;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Fx/combinators/throttle.ts",
            "start": {
              "line": 43,
              "column": 3
            },
            "end": {
              "line": 43,
              "column": 37
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": false
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly leading?: boolean | undefined;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Fx/combinators/throttle.ts",
            "start": {
              "line": 44,
              "column": 3
            },
            "end": {
              "line": 44,
              "column": 42
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": true
      },
      {
        "family": "property",
        "syntaxKind": "PropertySignature",
        "signatures": [
          "readonly trailing?: boolean | undefined;"
        ],
        "typeParameters": [],
        "sourceSpans": [
          {
            "file": "packages/fx/src/Fx/combinators/throttle.ts",
            "start": {
              "line": 45,
              "column": 3
            },
            "end": {
              "line": 45,
              "column": 43
            }
          }
        ],
        "static": false,
        "readonly": true,
        "optional": true
      }
    ],
    "signatures": [
      "export type ThrottleOptions = {\n    readonly duration: Duration.Input;\n    readonly leading?: boolean | undefined;\n    readonly trailing?: boolean | undefined;\n};"
    ],
    "typeParameters": [],
    "summary": "Options for {@link throttle}. A duration-only call is leading-edge\n(`{ leading: true, trailing: false }`).",
    "sections": {
      "Why": "Leading and trailing edges answer different interaction needs, so the\nwindow policy is explicit rather than hidden behind separate operators.",
      "Ownership and lifetime": "This immutable value owns no resource. `throttle` reads it when constructing\nthe Fx; the resulting subscription owns the timer and pending value."
    },
    "examples": [
      {
        "language": "ts",
        "code": "import type { ThrottleOptions } from \"@typed/fx/Fx\"\n\nconst options: ThrottleOptions = {\n  duration: \"250 millis\",\n  leading: true,\n  trailing: true\n}"
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/fx/src/Fx/combinators/throttle.ts",
        "start": {
          "line": 42,
          "column": 1
        },
        "end": {
          "line": 46,
          "column": 3
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/throttle.ts",
        "start": {
          "line": 43,
          "column": 3
        },
        "end": {
          "line": 43,
          "column": 37
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/throttle.ts",
        "start": {
          "line": 44,
          "column": 3
        },
        "end": {
          "line": 44,
          "column": 42
        }
      },
      {
        "file": "packages/fx/src/Fx/combinators/throttle.ts",
        "start": {
          "line": 45,
          "column": 3
        },
        "end": {
          "line": 45,
          "column": 43
        }
      }
    ],
    "since": "1.0.0",
    "category": "Operator options"
  }
}
