The finance developer workbenchSearch the reference Development · 0.1.4 · unpublished

@insiderfinance/totalfinance/core/schema

OrderBookLevelSchema · field contracts

Page 1 of 2. Back to the entry point or find this declaration.

Name / typeMeaning & unitOptional / default
_check
(input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { exchange?: string; price: number; size: number; }; }		@internal
unitless by name		Required / declared member
No @default declared; consult the signature and description.
_check().return.issues
import('@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
{ exchange?: string; price: number; size: 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).mode
import('@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.$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.
describe
(description: string) => 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>; }>
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.
description
string | undefined
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
'object'
unitless by name		Required / declared member
No @default declared; consult the signature and description.
open
() => 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>; }>		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<{ exchange?: string; price: number; size: 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: { exchange?: string; price: number; size: 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<{ exchange?: string; price: number; size: number; }>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.description
string | undefined
unitless by name		Required / declared member
No @default declared; consult the signature and description.
optional().return.isOptional
true
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<{ exchange?: string; price: number; size: 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) => { exchange?: string; price: number; size: 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<{ exchange?: string; price: number; size: 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.~standard
import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props<unknown, { exchange?: string; price: number; size: 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) => { exchange?: string; price: number; size: 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).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<{ exchange?: string; price: number; size: number; }>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
safeParse().return.data
{ exchange?: string; price: number; size: number; }
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, { exchange?: string; price: number; size: number; }>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
~standard.types
({ readonly input: unknown; readonly output: { exchange?: string; price: number; size: number; }; }) | 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
{ exchange?: string; price: number; size: 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<{ exchange?: string; price: number; size: 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.