StringType

Hierarchy

• NodeTrait
  • StringType

Index

Constructors

• constructor

Properties

• _attributes
• _canReference
• _children
• _connections
• _definition
• _hooks
• _id
• _isCommutative
• _name
• _options
• _sourcePath
• _transform
• _type
• infer
• input

Accessors

• _output

Methods

• arbitrary
• array
• base64
• compile
• date
• datetime
• default
• describe
• duration
• email
• hostname
• ipv4
• ipv6
• jsonschema
• maxLength
• minLength
• nullable
• optional
• reference
• regex
• time
• ulid
• uri
• uuid
• validator

Constructors

publicconstructor

• new StringType(options: SchemaOptions<StringOptions, string>): StringType

• Overrides NodeTrait.constructor

  Parameters

  • options: SchemaOptions<StringOptions, string>

  Returns StringType

Properties

public_attributes

_attributes: { generic: GenericAttributes; typescript: TypescriptAttributes } = ...

Inherited from NodeTrait._attributes

Type declaration

• generic: GenericAttributes

• typescript: TypescriptAttributes

publicoptional_canReference

_canReference?: boolean

Inherited from NodeTrait._canReference

publicoptional_children

_children?: Node[]

Inherited from NodeTrait._children

publicoptional_connections

_connections?: Node[]

Inherited from NodeTrait._connections

public_definition

_definition: ThereforeNodeDefinition<string> = {}

Inherited from NodeTrait._definition

publicoptional_hooks

_hooks?: Hooks

Inherited from NodeTrait._hooks

public_id

_id: string = ...

Inherited from NodeTrait._id

public_isCommutative

_isCommutative: boolean = true

Inherited from NodeTrait._isCommutative

publicoptional_name

_name?: string

Inherited from NodeTrait._name

public_options

_options: StringOptions = {}

publicoptional_sourcePath

_sourcePath?: string

Inherited from NodeTrait._sourcePath

publicoptional_transform

_transform?: { aliasName?: (name: string) => string; referenceName?: (name: string) => string; symbolName?: (name: string) => string }

Inherited from NodeTrait._transform

Type declaration

• optionalaliasName?: (name: string) => string

  • • (name: string): string

    • Parameters

      • name: string

      Returns string

• optionalreferenceName?: (name: string) => string

  • • (name: string): string

    • Parameters

      • name: string

      Returns string

• optionalsymbolName?: (name: string) => string

  • • (name: string): string

    • Parameters

      • name: string

      Returns string

public_type

_type: string = ...

Overrides NodeTrait._type

publicinfer

infer: string

Overrides NodeTrait.infer

publicinput

input: string

Overrides NodeTrait.input

Accessors

public_output

• get _output(): undefined | (TypescriptOutput | GenericOutput)[]

• Inherited from NodeTrait._output

  Returns undefined | (TypescriptOutput | GenericOutput)[]

Methods

publicarbitrary

• arbitrary(options: Partial<StringConstraints>): StringType

• Parameters

  • options: Partial<StringConstraints>

  Returns StringType

publicarray

• array(options?: SchemaOptions<ArrayOptions>): ArrayType<StringType>

• Inherited from NodeTrait.array

  Parameters

  • options: SchemaOptions<ArrayOptions> = {}

  Returns ArrayType<StringType>

publicbase64

• base64(): StringType

• Returns StringType

publiccompile

• compile(__namedParameters?: { formats?: boolean }): Schema<string>

• Inherited from NodeTrait.compile

  Parameters

  • __namedParameters: { formats?: boolean } = {}

  • optionalformats: boolean = true

  Returns Schema<string>

publicdate

• date(): StringType

• Returns StringType

publicdatetime

• datetime(): StringType

• Returns StringType

publicdefault

• default(value: string): DefaultType<StringType>

• Inherited from NodeTrait.default

  Parameters

  • value: string

  Returns DefaultType<StringType>

publicdescribe

• describe(description: string): this

• Inherited from NodeTrait.describe

  Parameters

  • description: string

  Returns this

publicduration

• duration(): StringType

• Returns StringType

publicemail

• email(): StringType

• Returns StringType

publichostname

• hostname(): StringType

• Returns StringType

publicipv4

• ipv4(): StringType

• Returns StringType

publicipv6

• ipv6(): StringType

• Returns StringType

publicjsonschema

• jsonschema(schema: JsonSchema<string>): this

• Inherited from NodeTrait.jsonschema

  Parameters

  • schema: JsonSchema<string>

  Returns this

publicmaxLength

• maxLength(maxLength: number): StringType

• Parameters

  • maxLength: number

  Returns StringType

publicminLength

• minLength(minLength: number): StringType

• Parameters

  • minLength: number

  Returns StringType

publicnullable

• nullable(): NullableType<StringType>

• Inherited from NodeTrait.nullable

  Returns NullableType<StringType>

publicoptional

• optional(): OptionalType<StringType>

• Inherited from NodeTrait.optional

  Returns OptionalType<StringType>

publicreference

• reference(options?: SchemaOptions<object>): RefType<StringType>

• Inherited from NodeTrait.reference

  Parameters

  • options: SchemaOptions<object> = {}

  Returns RefType<StringType>

publicregex

• regex(pattern: string | RegExp): StringType

• Parameters

  • pattern: string | RegExp

  Returns StringType

publictime

• time(): StringType

• Returns StringType

publiculid

• ulid(): StringType

• Returns StringType

publicuri

• uri(): StringType

• Returns StringType

publicuuid

• uuid(): StringType

• Returns StringType

publicvalidator

• validator(validator?: Partial<ValidatorOptions>): this

• Inherited from NodeTrait.validator

  Parameters

  • validator: Partial<ValidatorOptions> = {}

  Returns this