Interface OptionalPropertiesSchema<O>

a schema for an object with only optional properties

interface OptionalPropertiesSchema<O> {
    additionalProperties?: boolean;
    metadata?: unknown;
    nullable?: boolean;
    optionalProperties: O;
    properties?: undefined;
}

Type Parameters

O extends Readonly<Record<string, SomeSchema>> = Readonly<Record<string, SomeSchema>>

Index

Properties

additionalProperties? metadata? nullable? optionalProperties properties?

Properties

`Optional` `Readonly` additionalProperties

additionalProperties?: boolean

if non-listed properties are allowed

`Optional` `Readonly` metadata

metadata?: unknown

optional metadata on a schema

`Optional` `Readonly` nullable

nullable?: boolean

a key indicating if a type can be null

`Readonly` optionalProperties

optionalProperties: O

a schema for every optional property

`Optional` `Readonly` properties

properties?: undefined

optional properties defines no properties