Variable bsbConst

Type Declaration

• string: function

  • string(
        options?: {
            min?: number;
            max?: number;
            pattern?: string;
            description?: string;
        },
    ): StringSchema

    Parameters

    • Optionaloptions: { min?: number; max?: number; pattern?: string; description?: string }

    Returns StringSchema

• uuid: function

  • uuid(description?: string): StringSchema

    Parameters

    • Optionaldescription: string

    Returns StringSchema

• datetime: function

  • datetime(description?: string): StringSchema

    Parameters

    • Optionaldescription: string

    Returns StringSchema

• email: function

  • email(description?: string): StringSchema

    Parameters

    • Optionaldescription: string

    Returns StringSchema

• uri: function

  • uri(description?: string): StringSchema

    Parameters

    • Optionaldescription: string

    Returns StringSchema

• url: function

  • url(description?: string): StringSchema

    Parameters

    • Optionaldescription: string

    Returns StringSchema

• int32: function

  • int32(options?: { min?: number; max?: number; description?: string }): BSBType

    Parameters

    • Optionaloptions: { min?: number; max?: number; description?: string }

    Returns BSBType

• int64: function

  • int64(options?: { min?: number; max?: number; description?: string }): BSBType

    Parameters

    • Optionaloptions: { min?: number; max?: number; description?: string }

    Returns BSBType

• float: function

  • float(options?: { min?: number; max?: number; description?: string }): BSBType

    Parameters

    • Optionaloptions: { min?: number; max?: number; description?: string }

    Returns BSBType

• double: function

  • double(options?: { min?: number; max?: number; description?: string }): BSBType

    Parameters

    • Optionaloptions: { min?: number; max?: number; description?: string }

    Returns BSBType

• number: function

  • number(options?: { min?: number; max?: number; description?: string }): BSBType

    Parameters

    • Optionaloptions: { min?: number; max?: number; description?: string }

    Returns BSBType

• boolean: function

  • boolean(description?: string): BoolSchema

    Parameters

    • Optionaldescription: string

    Returns BoolSchema

• bytes: function

  • bytes(description?: string): UnknownSchema

    Parameters

    • Optionaldescription: string

    Returns UnknownSchema

• array: function

  • array(
        items: BSBType,
        options?: { min?: number; max?: number; description?: string },
    ): ArraySchema<BSBType>

    Parameters

    • items: BSBType
    • Optionaloptions: { min?: number; max?: number; description?: string }

    Returns ArraySchema<BSBType>

• object: function

  • object<T extends Record<string, BSBType>>(
        properties: T,
        description?: string,
    ): ObjectSchema<T>

    Type Parameters

    • T extends Record<string, BSBType>

    Parameters

    • properties: T
    • Optionaldescription: string

    Returns ObjectSchema<T>

• enum: function

  • enum(
        values: readonly (string | number)[],
        description?: string,
    ): EnumSchema<readonly (string | number)[]>

    Parameters

    • values: readonly (string | number)[]
    • Optionaldescription: string

    Returns EnumSchema<readonly (string | number)[]>

• union: function

  • union(
        types: BSBType[],
        description?: string,
    ): UnknownSchema | UnionSchema<[BSBType, ...BSBType[]]>

    Parameters

    • types: BSBType[]
    • Optionaldescription: string

    Returns UnknownSchema | UnionSchema<[BSBType, ...BSBType[]]>

• void: function

  • void(): UnknownSchema

    Returns UnknownSchema

• unknown: function

  • unknown(description?: string): UnknownSchema

    Parameters

    • Optionaldescription: string

    Returns UnknownSchema

• record: function

  • record<K extends BSBType, V extends BSBType>(
        _keyType: K,
        valueType: V,
        description?: string,
    ): RecordSchema<V>

    Type Parameters

    • K extends BSBType
    • V extends BSBType

    Parameters

    • _keyType: K
    • valueType: V
    • Optionaldescription: string

    Returns RecordSchema<V>