Interface ArgGuard

Useful for validation of input arguments on public API.

Throws

Hierarchy

ArgGuard

Index

Methods

address array enum function ifNotNullish nonEmptyArray nonEmptyString nonWhiteSpaceString number object oneOf string

Methods

address

address(value: string, argName: string, prefixes?: readonly AddressPrefix[]): string
Parameters
- value: string
- argName: string
- Optional prefixes: readonly AddressPrefix[]
Returns string

array

array<T>(value: T, argName: string): T
Type Parameters
- T extends readonly unknown[]
Parameters
- value: T
- argName: string
Returns T

enum

enum<TEnum>(value: TEnum, argName: string, enumType: Readonly<Record<string, TEnum>>): TEnum
Type Parameters
- TEnum extends string
Parameters
- value: TEnum
- argName: string
- enumType: Readonly<Record<string, TEnum>>
Returns TEnum

function

function<T>(value: T, argName: string): T
Type Parameters
- T extends Function
Parameters
- value: T
- argName: string
Returns T

ifNotNullish

ifNotNullish<T>(value: Nullish<T>, validate: ((value: T) => T)): Nullish<T>
Type Parameters
- T
Parameters
- value: Nullish<T>
- validate: ((value: T) => T)
  - - (value: T): T
    - Parameters
      
      value: T
      
      Returns T
Returns Nullish<T>

nonEmptyArray

nonEmptyArray<T>(value: T, argName: string): T
Type Parameters
- T extends readonly unknown[]
Parameters
- value: T
- argName: string
Returns T

nonEmptyString

nonEmptyString(value: string, argName: string): string
Parameters
- value: string
- argName: string
Returns string

nonWhiteSpaceString

nonWhiteSpaceString(value: string, argName: string): string
Parameters
- value: string
- argName: string
Returns string

number

number(value: number, argName: string, limits?: NumberLimits): number
Parameters
- value: number
- argName: string
- Optional limits: NumberLimits
Returns number

object

object<T>(value: T, argName: string, constructor?: Constructor<T>): T
Type Parameters
- T extends object
Parameters
- value: T
- argName: string
- Optional constructor: Constructor<T>
Returns T

oneOf

oneOf<TSupported, TValue>(value: TValue, argName: string, supportedValues: readonly TSupported[]): TValue
Type Parameters
- TSupported extends string
- TValue extends string
Parameters
- value: TValue
- argName: string
- supportedValues: readonly TSupported[]
Returns TValue

string

string(value: string, argName: string, limits?: StringLimits): string
Parameters
- value: string
- argName: string
- Optional limits: StringLimits
Returns string

Generated using TypeDoc