The finance developer workbenchSearch the reference Development · 0.1.4 · unpublished

Public API / @insiderfinance/totalfinance

@insiderfinance/totalfinance/core/schema

import from '@insiderfinance/totalfinance/core/schema'

Every public export in this entry point, including type-only declarations. Search by name or concept.

Jump to an export (46)

ArraySchema · BarSchema · BooleanSchema · CorporateActionSchema · DividendSchema · EnumSchema · Infer · InferObject · JSONSchema · JSONSchemaTypeName · JSON_SCHEMA_MAX_DEPTH · LiteralSchema · NumberConstraints · NumberSchema · ObjectSchema · OptionContractSchema · OptionQuoteSchema · OptionTradeSchema · OptionalSchema · OrderBookLevelSchema · OrderBookSchema · ParseOptions · QuoteSchema · RateCurvePointSchema · RateCurveSchema · RawFundamentalsRecordSchema · RecordSchema · SafeParseResult · Schema · SchemaCheckContext · SchemaIssue · StandardSchemaV1 · StandardSchemaV1Issue · StandardSchemaV1Props · StandardSchemaV1Result · StringConstraints · StringSchema · TradeSchema · UnionSchema · UnknownSchema · ValidationMode · __TOTALFINANCE_SCHEMA_FACADE__ · coreSchemas · requireJSONSchema · schema · validate

class

ArraySchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class ArraySchema<Item> extends BaseSchema<Item[]> {
  constructor(item: BaseSchema<Item>, bounds?: { min?: number; max?: number; });
  readonly kind: 'array';
  min(minimum: number): ArraySchema<Item>;
  max(maximum: number): ArraySchema<Item>;
  _check(input: unknown, context: SchemaCheckContext): CheckResult<Item[]>;
  _toJSONSchema(): JSONSchema;
  readonly isOptional: boolean;
  description: string | undefined;
  parse(input: unknown, options?: ParseOptions): Item[];
  safeParse(input: unknown, options?: ParseOptions): SafeParseResult<Item[]>;
  toJSONSchema(): JSONSchema;
  optional(): OptionalSchema<Item[]>;
  describe(description: string): ArraySchema<Item>;
  ~standard: StandardSchemaV1Props<unknown, Item[]>;
}
Fields, parameters & returned members (185)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

BarSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const BarSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; open: import('@insiderfinance/totalfinance/core/schema').NumberSchema; high: import('@insiderfinance/totalfinance/core/schema').NumberSchema; low: import('@insiderfinance/totalfinance/core/schema').NumberSchema; close: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; vwap: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; adjusted: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<boolean>; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

BooleanSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class BooleanSchema extends BaseSchema<boolean> {
  constructor();
  _check(input: unknown, context: SchemaCheckContext): CheckResult<boolean>;
  _toJSONSchema(): JSONSchema;
  describe(description: string): BooleanSchema;
  description: string | undefined;
  readonly isOptional: boolean;
  readonly kind: 'boolean';
  optional(): OptionalSchema<boolean>;
  parse(input: unknown, options?: ParseOptions): boolean;
  safeParse(input: unknown, options?: ParseOptions): SafeParseResult<boolean>;
  toJSONSchema(): JSONSchema;
  ~standard: StandardSchemaV1Props<unknown, boolean>;
}
Fields, parameters & returned members (164)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

CorporateActionSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const CorporateActionSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; effectiveDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'>; ratio: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; cash: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; newSymbol: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string>; details: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<Record<string, unknown>>; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

DividendSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const DividendSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; exDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; payDate: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string>; amount: import('@insiderfinance/totalfinance/core/schema').NumberSchema; currency: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string>; type: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'unknown' | 'regular' | 'special' | 'returnOfCapital'>; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

EnumSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class EnumSchema<V extends string> extends BaseSchema<V> {
  constructor(values: readonly V[]);
  readonly kind: 'enum';
  _check(input: unknown, context: SchemaCheckContext): CheckResult<V>;
  _toJSONSchema(): JSONSchema;
  readonly isOptional: boolean;
  description: string | undefined;
  parse(input: unknown, options?: ParseOptions): V;
  safeParse(input: unknown, options?: ParseOptions): SafeParseResult<V>;
  toJSONSchema(): JSONSchema;
  optional(): OptionalSchema<V>;
  describe(description: string): EnumSchema<V>;
  ~standard: StandardSchemaV1Props<unknown, V>;
}
Fields, parameters & returned members (165)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

type

Infer

Extract the validated output type of a schema.

/** Extract the validated output type of a schema. */
export type Infer<S> = S extends Schema<infer O> ? O : never;
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

type

InferObject

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export type InferObject<Shape extends Record<string, Schema<unknown>>> = Prettify<{
    [K in RequiredShapeKeys<Shape>]: Infer<Shape[K]>;
} & {
    [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>;
}>;
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

JSONSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export interface JSONSchema {
    $schema?: string;
    $id?: string;
    title?: string;
    description?: string;
    type?: JSONSchemaTypeName | JSONSchemaTypeName[];
    enum?: unknown[];
    const?: unknown;
    default?: unknown;
    // object
    properties?: Record<string, JSONSchema>;
    required?: string[];
    additionalProperties?: boolean | JSONSchema;
    // array
    items?: JSONSchema;
    minItems?: number;
    maxItems?: number;
    // number
    minimum?: number;
    maximum?: number;
    exclusiveMinimum?: number;
    exclusiveMaximum?: number;
    multipleOf?: number;
    // string
    minLength?: number;
    maxLength?: number;
    pattern?: string;
    format?: string;
    // composition
    anyOf?: JSONSchema[];
    oneOf?: JSONSchema[];
    allOf?: JSONSchema[];
    /** Allow vendor/extension keywords without losing type-checking on the known ones. */
    [key: string]: unknown;
}
Fields, parameters & returned members (52)
Name / typeMeaning & unitOptional / default
$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties
boolean | JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.additionalProperties
boolean | JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.allOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.anyOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.items
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
additionalProperties.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
additionalProperties.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.oneOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.properties
Record<string, JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
additionalProperties.type
JSONSchemaTypeName | JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
allOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
anyOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
description
string
unitless by name		Optional
No @default declared; consult the signature and description.
enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
format
string
unitless by name		Optional
No @default declared; consult the signature and description.
items
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
oneOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
properties
Record<string, JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
title
string
unitless by name		Optional
No @default declared; consult the signature and description.
type
JSONSchemaTypeName | JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

type

JSONSchemaTypeName

A pragmatic JSON Schema (Draft 2020-12) shape — enough for MCP tools and docs.

/** A pragmatic JSON Schema (Draft 2020-12) shape — enough for MCP tools and docs. */
export type JSONSchemaTypeName = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

JSON_SCHEMA_MAX_DEPTH

The deepest nesting a document may declare; deeper is a cycle, not a schema.

export declare const JSON_SCHEMA_MAX_DEPTH: 64;
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

LiteralSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class LiteralSchema<V extends string | number | boolean> extends BaseSchema<V> {
  constructor(value: V);
  readonly kind: 'literal';
  _check(input: unknown, context: SchemaCheckContext): CheckResult<V>;
  _toJSONSchema(): JSONSchema;
  readonly isOptional: boolean;
  description: string | undefined;
  parse(input: unknown, options?: ParseOptions): V;
  safeParse(input: unknown, options?: ParseOptions): SafeParseResult<V>;
  toJSONSchema(): JSONSchema;
  optional(): OptionalSchema<V>;
  describe(description: string): LiteralSchema<V>;
  ~standard: StandardSchemaV1Props<unknown, V>;
}
Fields, parameters & returned members (165)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

NumberConstraints

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

// ---------------------------------------------------------------------------
// number
// ---------------------------------------------------------------------------
export interface NumberConstraints {
    integer?: boolean;
    min?: number;
    max?: number;
    exclusiveMin?: number;
    exclusiveMax?: number;
}
Fields, parameters & returned members (5)
Name / typeMeaning & unitOptional / default
exclusiveMax
number
unitless by name		Optional
No @default declared; consult the signature and description.
exclusiveMin
number
unitless by name		Optional
No @default declared; consult the signature and description.
integer
boolean
unitless by name		Optional
No @default declared; consult the signature and description.
max
number
unitless by name		Optional
No @default declared; consult the signature and description.
min
number
unitless by name		Optional
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

NumberSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class NumberSchema extends BaseSchema<number> {
  constructor(constraints?: NumberConstraints);
  _check(input: unknown, context: SchemaCheckContext): CheckResult<number>;
  _toJSONSchema(): JSONSchema;
  describe(description: string): NumberSchema;
  description: string | undefined;
  gt(value: number): NumberSchema;
  integer(): NumberSchema;
  readonly isOptional: boolean;
  readonly kind: 'number';
  lt(value: number): NumberSchema;
  max(value: number): NumberSchema;
  min(value: number): NumberSchema;
  nonnegative(): NumberSchema;
  optional(): OptionalSchema<number>;
  parse(input: unknown, options?: ParseOptions): number;
  positive(): NumberSchema;
  safeParse(input: unknown, options?: ParseOptions): SafeParseResult<number>;
  toJSONSchema(): JSONSchema;
  ~standard: StandardSchemaV1Props<unknown, number>;
}
Fields, parameters & returned members (188)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

ObjectSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class ObjectSchema<Shape extends Record<string, Schema<unknown>>> extends BaseSchema<
  InferObject<Shape>
> {
  constructor(shape: Shape);
  readonly kind: 'object';
  open(): ObjectSchema<Shape>;
  _check(input: unknown, context: SchemaCheckContext): CheckResult<InferObject<Shape>>;
  _toJSONSchema(): JSONSchema;
  readonly isOptional: boolean;
  description: string | undefined;
  parse(input: unknown, options?: ParseOptions): { [K in keyof ({ [K in Exclude<keyof Shape, OptionalShapeKeys<Shape>>]: Infer<Shape[K]>; } & { [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>; })]: ({ [K in Exclude<keyof Shape, OptionalShapeKeys<Shape>>]: Infer<Shape[K]>; } & { [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>; })[K]; };
  safeParse(input: unknown, options?: ParseOptions): SafeParseResult<{ [K in keyof ({ [K in Exclude<keyof Shape, OptionalShapeKeys<Shape>>]: Infer<Shape[K]>; } & { [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>; })]: ({ [K in Exclude<keyof Shape, OptionalShapeKeys<Shape>>]: Infer<Shape[K]>; } & { [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>; })[K]; }>;
  toJSONSchema(): JSONSchema;
  optional(): OptionalSchema<{ [K in keyof ({ [K in Exclude<keyof Shape, OptionalShapeKeys<Shape>>]: Infer<Shape[K]>; } & { [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>; })]: ({ [K in Exclude<keyof Shape, OptionalShapeKeys<Shape>>]: Infer<Shape[K]>; } & { [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>; })[K]; }>;
  describe(description: string): ObjectSchema<Shape>;
  ~standard: StandardSchemaV1Props<unknown, { [K in keyof ({ [K in Exclude<keyof Shape, OptionalShapeKeys<Shape>>]: Infer<Shape[K]>; } & { [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>; })]: ({ [K in Exclude<keyof Shape, OptionalShapeKeys<Shape>>]: Infer<Shape[K]>; } & { [K in OptionalShapeKeys<Shape>]?: Exclude<Infer<Shape[K]>, undefined>; })[K]; }>;
}
Fields, parameters & returned members (167)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

OptionContractSchema

E2 — the contract schema validates the RESOLVED ARTIFACT cross-field, not just field shapes: after the structural parse, `validateResolvedExpiry` confirms the label ↔ instant ↔ convention triple is internally consistent (impossible dates, mismatched epochs, and contradictory conventions all reject), and the parsed value is DEEP-frozen — the artifact (including `deliverable` and its `shares[]`) stays immutable through the schema boundary exactly as it left the builders.

export declare const OptionContractSchema: 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; }>;
Fields, parameters & returned members (88)
Name / typeMeaning & unitOptional / default
describe
(description: string) => 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; }>
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.
isOptional
boolean
unitless by name		Required / declared member
No @default declared; consult the signature and description.
kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional
() => 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; } | undefined>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.describe
(description: string) => 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; } | undefined>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.isOptional
boolean
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.optional
() => 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; } | 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) => { 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; } | 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<{ 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; } | 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.~standard
import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props<unknown, { 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; } | 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) => { 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; }
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).mode
import('@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<{ 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; }>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
safeParse().return.data
{ 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; }
unitless by name		Required / declared member
No @default declared; consult the signature and description.
safeParse().return.error
import('@insiderfinance/totalfinance/core').InputError
unitless by name		Required / declared member
No @default declared; consult the signature and description.
safeParse().return.issues
import('@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).mode
import('@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.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties
boolean | import('@insiderfinance/totalfinance/core').JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.additionalProperties
boolean | import('@insiderfinance/totalfinance/core').JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.allOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.anyOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.items
import('@insiderfinance/totalfinance/core').JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.oneOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.properties
Record<string, import('@insiderfinance/totalfinance/core').JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.type
import('@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.allOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.anyOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.items
import('@insiderfinance/totalfinance/core').JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.oneOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.properties
Record<string, import('@insiderfinance/totalfinance/core').JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.type
import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
~standard
import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props<unknown, { 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; }>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types
({ readonly input: unknown; readonly output: { 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; }; }) | undefined
unitless by name		Optional
No @default declared; consult the signature and description.
~standard.types.input
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output
{ 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; }
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.validate
(value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ 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; }>
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.
~standard.validate().return.value
{ 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; }
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.validate(value)
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.vendor
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.version
1
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

OptionQuoteSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const OptionQuoteSchema: 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>; greeks: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string>; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string[]>; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

OptionTradeSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const OptionTradeSchema: 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>; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

class

OptionalSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare class OptionalSchema<T> extends BaseSchema<T | undefined> {
  constructor(inner: BaseSchema<T>);
  readonly isOptional: true;
  readonly kind: 'optional';
  _check(input: unknown, context: SchemaCheckContext): CheckResult<T | undefined>;
  _toJSONSchema(): JSONSchema;
  optional(): OptionalSchema<T | undefined>;
  description: string | undefined;
  parse(input: unknown, options?: ParseOptions): T | undefined;
  safeParse(input: unknown, options?: ParseOptions): SafeParseResult<T | undefined>;
  toJSONSchema(): JSONSchema;
  describe(description: string): OptionalSchema<T>;
  ~standard: StandardSchemaV1Props<unknown, T | undefined>;
}
Fields, parameters & returned members (176)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

OrderBookLevelSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const OrderBookLevelSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string>; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

OrderBookSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const OrderBookSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bids: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ exchange?: string; price: number; size: number; }>; asks: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ exchange?: string; price: number; size: number; }>; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

ParseOptions

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export interface ParseOptions {
    /** Validation strictness (spec §6). Defaults to `strict`. */
    mode?: ValidationMode;
}
Fields, parameters & returned members (1)
Name / typeMeaning & unitOptional / default
mode
ValidationMode		Validation strictness (spec §6). Defaults to `strict`.
unitless by name		Optional
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

QuoteSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const QuoteSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').NumberSchema; ask: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<number>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string>; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<string[]>; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

RateCurvePointSchema

OPEN (2026-08-23, fourth external review): `RateCurvePoint` entries are documented "open to vendor decoration (Law 12)" and the runtime curve validator accepts a decorated pillar, but this schema was CLOSED — the one schema-vs-runtime openness misstatement in this module. `.open()` validates the declared pillar shape and preserves decoration, and the emitted JSON Schema now says `additionalProperties: true` instead of lying `false`.

export declare const RateCurvePointSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ date: import('@insiderfinance/totalfinance/core/schema').StringSchema; zeroRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; }>;
Fields, parameters & returned members (154)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

value

RateCurveSchema

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare const RateCurveSchema: import('@insiderfinance/totalfinance/core/schema').Schema<import('@insiderfinance/totalfinance/core').RateCurve>;
Fields, parameters & returned members (102)
Name / typeMeaning & unitOptional / default
describe
(description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<import('@insiderfinance/totalfinance/core').RateCurve>
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.
isOptional
boolean
unitless by name		Required / declared member
No @default declared; consult the signature and description.
kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional
() => import('@insiderfinance/totalfinance/core/schema').Schema<import('@insiderfinance/totalfinance/core').RateCurve | undefined>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.describe
(description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<import('@insiderfinance/totalfinance/core').RateCurve | undefined>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.isOptional
boolean
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.optional
() => import('@insiderfinance/totalfinance/core/schema').Schema<import('@insiderfinance/totalfinance/core').RateCurve | 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) => import('@insiderfinance/totalfinance/core').RateCurve | 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<import('@insiderfinance/totalfinance/core').RateCurve | 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.~standard
import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props<unknown, import('@insiderfinance/totalfinance/core').RateCurve | 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) => import('@insiderfinance/totalfinance/core').RateCurve
unitless by name		Required / declared member
No @default declared; consult the signature and description.
parse().return.asOf
number
an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)		Required / declared member
No @default declared; consult the signature and description.
parse().return.compounding
InterestCompounding
unitless by name		Required / declared member
No @default declared; consult the signature and description.
parse().return.currency
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
parse().return.dayCount
DayCount
count (integer)		Required / declared member
No @default declared; consult the signature and description.
parse().return.interpolation
string
unitless by name		Optional
No @default declared; consult the signature and description.
parse().return.points
import('@insiderfinance/totalfinance/core').RateCurvePoint[]
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).mode
import('@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<import('@insiderfinance/totalfinance/core').RateCurve>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
safeParse().return.data
import('@insiderfinance/totalfinance/core').RateCurve
unitless by name		Required / declared member
No @default declared; consult the signature and description.
safeParse().return.error
import('@insiderfinance/totalfinance/core').InputError
unitless by name		Required / declared member
No @default declared; consult the signature and description.
safeParse().return.issues
import('@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).mode
import('@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.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties
boolean | import('@insiderfinance/totalfinance/core').JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.additionalProperties
boolean | import('@insiderfinance/totalfinance/core').JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.allOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.anyOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.items
import('@insiderfinance/totalfinance/core').JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.oneOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.properties
Record<string, import('@insiderfinance/totalfinance/core').JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.additionalProperties.type
import('@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.allOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.anyOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.items
import('@insiderfinance/totalfinance/core').JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.oneOf
import('@insiderfinance/totalfinance/core').JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.properties
Record<string, import('@insiderfinance/totalfinance/core').JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
toJSONSchema().return.type
import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
~standard
import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props<unknown, import('@insiderfinance/totalfinance/core').RateCurve>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types
({ readonly input: unknown; readonly output: import('@insiderfinance/totalfinance/core').RateCurve; }) | undefined
unitless by name		Optional
No @default declared; consult the signature and description.
~standard.types.input
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output
import('@insiderfinance/totalfinance/core').RateCurve
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output.asOf
number
an instant: epoch milliseconds or a YYYY-MM-DD / zoned ISO string (the resolveAsOf convention)		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output.compounding
InterestCompounding
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output.compounding.periodsPerYear
number
per year (count)		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output.compounding.type
'periodic'
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output.currency
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output.dayCount
DayCount
count (integer)		Required / declared member
No @default declared; consult the signature and description.
~standard.types.output.interpolation
string
unitless by name		Optional
No @default declared; consult the signature and description.
~standard.types.output.points
import('@insiderfinance/totalfinance/core').RateCurvePoint[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.validate
(value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<import('@insiderfinance/totalfinance/core').RateCurve>
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.
~standard.validate().return.value
import('@insiderfinance/totalfinance/core').RateCurve
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.validate(value)
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.vendor
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.version
1
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
stable-by-law (pre-1.0; not a 1.0 stability guarantee)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.