ow
Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T: TypedArray

Hierarchy

  • Predicate<T>
    • TypedArrayPredicate

Implements

  • BasePredicate<T>

Index

Constructors

constructor

Accessors

not

  • get not(): this

Methods

Protected addValidator

  • addValidator(validator: Validator<T>): this
  • Register a new validator.

    Parameters

    • validator: Validator<T>

      Validator to register.

    Returns this

byteLength

  • byteLength(byteLength: number): this
  • Test a typed array to have a specific byte length.

    Parameters

    • byteLength: number

      The byte length of the typed array.

    Returns this

is

  • is(validator: (value: T) => boolean | string): this
  • Test if the value matches a custom validation function. The validation function should return true if the value passes the function. If the function either returns false or a string, the function fails and the string will be used as error message.

    Parameters

    • validator: (value: T) => boolean | string

      Validation function.

        • (value: T): boolean | string
        • Parameters

          • value: T

          Returns boolean | string

    Returns this

length

  • length(length: number): this

maxByteLength

  • maxByteLength(byteLength: number): this

maxLength

  • maxLength(length: number): this

message

  • Provide a new error message to be thrown when the validation fails.

    example
    ow('🌈', 'unicorn', ow.string.equals('🦄').message('Expected unicorn, got rainbow'));
    //=> ArgumentError: Expected unicorn, got rainbow
    example
    ow('🌈', ow.string.minLength(5).message((value, label) => `Expected ${label}, to have a minimum length of 5, got \`${value}\``));
    //=> ArgumentError: Expected string, to be have a minimum length of 5, got `🌈`

    Parameters

    • newMessage: string | ValidatorMessageBuilder<T>

      Either a string containing the new message or a function returning the new message.

    Returns this

minByteLength

  • minByteLength(byteLength: number): this
  • Test a typed array to have a minimum byte length.

    Parameters

    • byteLength: number

      The minimum byte length of the typed array.

    Returns this

minLength

  • minLength(length: number): this

validate

  • Test if the value matches a custom validation function. The validation function should return an object containing a validator and message. If the validator is false, the validation fails and the message will be used as error message. If the message is a function, the function is invoked with the label as argument to let you further customize the error message.

    Parameters

    Returns this