@insiderfinance/totalfinance/core/schema
OptionTradeSchema · field contracts
Page 1 of 2. Back to the entry point or find this declaration.
| Name / type | Meaning & unit | Optional / default |
|---|---|---|
_check(input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; } | @internal unitless by name | Required / declared member No @default declared; consult the signature and description. |
_check().return.issuesimport('@insiderfinance/totalfinance/core/schema').SchemaIssue[] | unitless by name | Required / declared member No @default declared; consult the signature and description. |
_check().return.ok(false) | (true) | unitless by name | Required / declared member No @default declared; consult the signature and description. |
_check().return.value{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | unitless by name | Required / declared member No @default declared; consult the signature and description. |
_check(context)import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext | unitless by name | Required / declared member No @default declared; consult the signature and description. |
_check(context).modeimport('@insiderfinance/totalfinance/core/schema').ValidationMode | unitless by name | Required / declared member No @default declared; consult the signature and description. |
_check(context).path(string | number)[] | unitless by name | Required / declared member No @default declared; consult the signature and description. |
_check(input)unknown | unitless by name | Required / declared member No @default declared; consult the signature and description. |
_toJSONSchema() => import('@insiderfinance/totalfinance/core').JSONSchema | @internal unitless by name | Required / declared member No @default declared; consult the signature and description. |
_toJSONSchema().return.$idstring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.$schemastring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalPropertiesboolean | import('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.$idstring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.$schemastring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.additionalPropertiesboolean | import('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.allOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.anyOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.constunknown | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.defaultunknown | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.descriptionstring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.enumunknown[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.exclusiveMaximumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.exclusiveMinimumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.formatstring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.itemsimport('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.maxItemsnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.maxLengthnumber | count (integer) | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.maximumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.minItemsnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.minLengthnumber | count (integer) | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.minimumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.multipleOfnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.oneOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.patternstring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.propertiesRecord<string, import('@insiderfinance/totalfinance/core').JSONSchema> | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.requiredstring[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.titlestring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.additionalProperties.typeimport('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.allOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.anyOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.constunknown | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.defaultunknown | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.descriptionstring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.enumunknown[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.exclusiveMaximumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.exclusiveMinimumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.formatstring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.itemsimport('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.maxItemsnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.maxLengthnumber | count (integer) | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.maximumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.minItemsnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.minLengthnumber | count (integer) | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.minimumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.multipleOfnumber | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.oneOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.patternstring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.propertiesRecord<string, import('@insiderfinance/totalfinance/core').JSONSchema> | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.requiredstring[] | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.titlestring | unitless by name | Optional No @default declared; consult the signature and description. |
_toJSONSchema().return.typeimport('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[] | unitless by name | Optional No @default declared; consult the signature and description. |
describe(description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string>; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string[]>; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<boolean>; }> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
describe(description)string | unitless by name | Required / declared member No @default declared; consult the signature and description. |
descriptionstring | undefined | unitless by name | Required / declared member No @default declared; consult the signature and description. |
isOptionalboolean | unitless by name | Required / declared member No @default declared; consult the signature and description. |
kind'object' | unitless by name | Required / declared member No @default declared; consult the signature and description. |
open() => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string>; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string[]>; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<boolean>; }> | Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still
fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload
whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then
emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP
tools, agents, and generated forms see the real field shape instead of a shapeless object.
Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a
property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all
agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself
remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional() => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return._check(input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; } | @internal unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return._toJSONSchema() => import('@insiderfinance/totalfinance/core').JSONSchema | @internal unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.describe(description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.descriptionstring | undefined | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.isOptionaltrue | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.kind'optional' | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.optional() => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.parse(input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.safeParse(input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.toJSONSchema() => import('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Required / declared member No @default declared; consult the signature and description. |
optional().return.~standardimport('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props<unknown, { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
parse(input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | unitless by name | Required / declared member No @default declared; consult the signature and description. |
parse(input)unknown | unitless by name | Required / declared member No @default declared; consult the signature and description. |
parse(options)import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined | unitless by name | Optional No @default declared; consult the signature and description. |
parse(options).modeimport('@insiderfinance/totalfinance/core/schema').ValidationMode | Validation strictness (spec §6). Defaults to `strict`. unitless by name | Optional No @default declared; consult the signature and description. |
safeParse(input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
safeParse().return.data{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | unitless by name | Required / declared member No @default declared; consult the signature and description. |
safeParse().return.errorimport('@insiderfinance/totalfinance/core').InputError | unitless by name | Required / declared member No @default declared; consult the signature and description. |
safeParse().return.issuesimport('@insiderfinance/totalfinance/core/schema').SchemaIssue[] | unitless by name | Required / declared member No @default declared; consult the signature and description. |
safeParse().return.success(false) | (true) | unitless by name | Required / declared member No @default declared; consult the signature and description. |
safeParse(input)unknown | unitless by name | Required / declared member No @default declared; consult the signature and description. |
safeParse(options)import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined | unitless by name | Optional No @default declared; consult the signature and description. |
safeParse(options).modeimport('@insiderfinance/totalfinance/core/schema').ValidationMode | Validation strictness (spec §6). Defaults to `strict`. unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema() => import('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Required / declared member No @default declared; consult the signature and description. |
toJSONSchema().return.$idstring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.$schemastring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalPropertiesboolean | import('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.$idstring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.$schemastring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.additionalPropertiesboolean | import('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.allOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.anyOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.constunknown | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.defaultunknown | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.descriptionstring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.enumunknown[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.exclusiveMaximumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.exclusiveMinimumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.formatstring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.itemsimport('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.maxItemsnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.maxLengthnumber | count (integer) | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.maximumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.minItemsnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.minLengthnumber | count (integer) | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.minimumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.multipleOfnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.oneOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.patternstring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.propertiesRecord<string, import('@insiderfinance/totalfinance/core').JSONSchema> | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.requiredstring[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.titlestring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.additionalProperties.typeimport('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.allOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.anyOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.constunknown | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.defaultunknown | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.descriptionstring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.enumunknown[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.exclusiveMaximumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.exclusiveMinimumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.formatstring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.itemsimport('@insiderfinance/totalfinance/core').JSONSchema | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.maxItemsnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.maxLengthnumber | count (integer) | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.maximumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.minItemsnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.minLengthnumber | count (integer) | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.minimumnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.multipleOfnumber | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.oneOfimport('@insiderfinance/totalfinance/core').JSONSchema[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.patternstring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.propertiesRecord<string, import('@insiderfinance/totalfinance/core').JSONSchema> | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.requiredstring[] | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.titlestring | unitless by name | Optional No @default declared; consult the signature and description. |
toJSONSchema().return.typeimport('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[] | unitless by name | Optional No @default declared; consult the signature and description. |
~standardimport('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props<unknown, { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
~standard.types({
readonly input: unknown;
readonly output: {
aggressorSide?: 'buy' | 'sell' | 'unknown';
ask?: number;
askSize?: number;
bid?: number;
bidSize?: number;
conditions?: string[];
contract: {
adjusted?: boolean;
currency?: string;
deliverable?: {
cash?: number;
shares?: {
symbol: string;
quantity: number;
}[];
notes?: string;
};
exerciseTime?: 'AM' | 'PM';
expiresAt: number;
expiry: string;
expiryConvention: 'us-equity-close' | 'explicit-instant';
multiplier?: number;
occSymbol?: string;
root?: string;
settlement?: 'physical' | 'cash';
strike: number;
style: 'european' | 'american';
type: 'call' | 'put';
underlying: string;
};
exchange?: string;
impliedVolatility?: number;
last?: number;
mark?: number;
mid?: number;
notional?: number;
openInterest?: number;
openingLikely?: boolean;
premium?: number;
price: number;
sequence?: number;
size: number;
timestampMs: number;
underlyingPrice?: number;
volume?: number;
};
}) | undefined | unitless by name | Optional No @default declared; consult the signature and description. |
~standard.types.inputunknown | unitless by name | Required / declared member No @default declared; consult the signature and description. |
~standard.types.output{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | unitless by name | Required / declared member No @default declared; consult the signature and description. |
~standard.validate(value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }> | unitless by name | Required / declared member No @default declared; consult the signature and description. |
~standard.validate().return.issues(readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined) | unitless by name | Optional No @default declared; consult the signature and description. |