Variable s`Const`

s: {
    array<Item>(
        item: StandardSchemaV1<unknown, Item>,
    ): StandardSchemaV1<unknown, Item[]>;
    boolean(): StandardSchemaV1<unknown, boolean>;
    custom<Output>(
        check: (value: unknown) => value is Output,
        message?: string,
    ): StandardSchemaV1<unknown, Output>;
    enum<
        const T extends
            readonly [string | number | boolean, string | number | boolean],
    >(
        ...values: T,
    ): StandardSchemaV1<unknown, T[number]>;
    nullable<Output>(
        inner: StandardSchemaV1<unknown, Output>,
    ): StandardSchemaV1<unknown, Output | null>;
    number(options?: NumberOptions): StandardSchemaV1<unknown, number>;
    object<Shape extends Record<string, StandardSchemaV1<unknown, unknown>>>(
        shape: Shape,
    ): StandardSchemaV1<
        unknown,
        { [K in string
        | number
        | symbol]: Infer<Shape[K]> },
    >;
    optional<Output>(
        inner: StandardSchemaV1<unknown, Output>,
    ): StandardSchemaV1<unknown, Output | undefined>;
    record<Value>(
        value: StandardSchemaV1<unknown, Value>,
    ): StandardSchemaV1<unknown, Record<string, Value>>;
    string(options?: StringOptions): StandardSchemaV1<unknown, string>;
    unknown(): StandardSchemaV1<unknown, unknown>;
} = ...

Built-in schema builders. Dependency-free; supply any synchronous Standard Schema implementation through StandardSchemaV1 when more expressive validation or transformation is needed.

Composite builders stop at the first issue and prefix its path. object projects the declared shape and does not copy unknown properties. These are intentionally small defaults, not a replacement for a full schema library.

Type Declaration

array: function
- array<Item>(
  item: StandardSchemaV1<unknown, Item>,
  ): StandardSchemaV1<unknown, Item[]>
  Type Parameters
  - Item
  Parameters
  - item: StandardSchemaV1<unknown, Item>
  Returns StandardSchemaV1<unknown, Item[]>
  - Defined in src/capabilities/core/schema.ts:239
boolean: function
- boolean(): StandardSchemaV1<unknown, boolean>
  Returns StandardSchemaV1<unknown, boolean>
  - Defined in src/capabilities/core/schema.ts:224
custom: function
- custom<Output>(
  check: (value: unknown) => value is Output,
  message?: string,
  ): StandardSchemaV1<unknown, Output>
  Escape hatch: builds a schema from a type guard.
  Type Parameters
  - Output
  Parameters
  - check: (value: unknown) => value is Output
  - message: string = 'invalid value'
  Returns StandardSchemaV1<unknown, Output>
  - Defined in src/capabilities/core/schema.ts:332
enum: function
- enum<
      const T extends
          readonly [string | number | boolean, string | number | boolean],
  >(
      ...values: T,
  ): StandardSchemaV1<unknown, T[number]>
  A union of literal values; the output type narrows to the union.
  Type Parameters
  - const T extends readonly [string | number | boolean, string | number | boolean]
  Parameters
  - ...values: T
  Returns StandardSchemaV1<unknown, T[number]>
  - Defined in src/capabilities/core/schema.ts:229
nullable: function
- nullable<Output>(
  inner: StandardSchemaV1<unknown, Output>,
  ): StandardSchemaV1<unknown, Output | null>
  Accepts null in addition to the inner schema.
  
  VS Code settings commonly use "type": ["string", "null"] with a null default to mean "unset", which s.optional (which admits undefined) does not cover.
  Type Parameters
  - Output
  Parameters
  - inner: StandardSchemaV1<unknown, Output>
  Returns StandardSchemaV1<unknown, Output | null>
  - Defined in src/capabilities/core/schema.ts:292
number: function
- number(options?: NumberOptions): StandardSchemaV1<unknown, number>
  Parameters
  - options: NumberOptions = {}
  Returns StandardSchemaV1<unknown, number>
  - Defined in src/capabilities/core/schema.ts:206
object: function
- object<Shape extends Record<string, StandardSchemaV1<unknown, unknown>>>(
      shape: Shape,
  ): StandardSchemaV1<
      unknown,
      { [K in string
      | number
      | symbol]: Infer<Shape[K]> },
  >
  Type Parameters
  - Shape extends Record<string, StandardSchemaV1<unknown, unknown>>
  Parameters
  - shape: Shape
  Returns StandardSchemaV1<unknown, { [K in string | number | symbol]: Infer<Shape[K]> }>
  - Defined in src/capabilities/core/schema.ts:257
optional: function
- optional<Output>(
  inner: StandardSchemaV1<unknown, Output>,
  ): StandardSchemaV1<unknown, Output | undefined>
  Accepts undefined in addition to the inner schema.
  Type Parameters
  - Output
  Parameters
  - inner: StandardSchemaV1<unknown, Output>
  Returns StandardSchemaV1<unknown, Output | undefined>
  - Defined in src/capabilities/core/schema.ts:279
record: function
- record<Value>(
  value: StandardSchemaV1<unknown, Value>,
  ): StandardSchemaV1<unknown, Record<string, Value>>
  A string-keyed record with uniformly-typed values.
  
  Keys come from the input, which for a record is the whole point — and JSON.parse produces __proto__ as a genuine own property, so a record built from parsed JSON can carry one. See defineOwn in foundation/internal/record.ts for why that key is not written with output[key] = ….
  Type Parameters
  - Value
  Parameters
  - value: StandardSchemaV1<unknown, Value>
  Returns StandardSchemaV1<unknown, Record<string, Value>>
  - Defined in src/capabilities/core/schema.ts:306
string: function
- string(options?: StringOptions): StandardSchemaV1<unknown, string>
  Parameters
  - options: StringOptions = {}
  Returns StandardSchemaV1<unknown, string>
  - Defined in src/capabilities/core/schema.ts:188
unknown: function
- unknown(): StandardSchemaV1<unknown, unknown>
  Passes any value through unchanged.
  
  Returns StandardSchemaV1<unknown, unknown>
  - Defined in src/capabilities/core/schema.ts:327

Example

const schema = s.object({
  name: s.string({ minLength: 1 }),
  tags: s.array(s.string()),
  mode: s.enum('fast', 'thorough'),
  limit: s.optional(s.number({ integer: true, min: 1 })),
});
type Value = Infer<typeof schema>;

Variable sConst

Type Declaration

array: function

Type Parameters

Parameters

Returns StandardSchemaV1<unknown, Item[]>

boolean: function

Returns StandardSchemaV1<unknown, boolean>

custom: function

Type Parameters

Parameters

Returns StandardSchemaV1<unknown, Output>

enum: function

Type Parameters

Parameters

Returns StandardSchemaV1<unknown, T[number]>

nullable: function

Type Parameters

Parameters

Returns StandardSchemaV1<unknown, Output | null>

number: function

Parameters

Returns StandardSchemaV1<unknown, number>

object: function

Type Parameters

Parameters

Returns StandardSchemaV1<unknown, { [K in string | number | symbol]: Infer<Shape[K]> }>

optional: function

Type Parameters

Parameters

Returns StandardSchemaV1<unknown, Output | undefined>

record: function

Type Parameters

Parameters

Returns StandardSchemaV1<unknown, Record<string, Value>>

string: function

Parameters

Returns StandardSchemaV1<unknown, string>

unknown: function

Returns StandardSchemaV1<unknown, unknown>

Example

Settings

Variable s`Const`