Class ArrayTypeInformation<T>

Type for defining an array of specific types

Type Parameters

T extends AllowAnyTypeInformation
The array type

Hierarchy

TypeInformation<PrimitiveType<T>[]>
- ArrayTypeInformation

Index

Constructors

Properties

maxItems? minItems? values

Accessors

Methods

check checkError exportToJson exportToString importFromJson importFromString json sendableVia toString

Constructors

constructor

new ArrayTypeInformation<T>(values, __namedParameters?): ArrayTypeInformation<T>
Type Parameters
- T extends TypeInformation<any, any, T>
Parameters
- values: T
- __namedParameters: {
  maxItems?: number;
  minItems?: number;
  } = {}
  - Optional maxItems?: number
  - Optional minItems?: number
Returns ArrayTypeInformation<T>
Overrides TypeInformation.constructor
- Defined in packages/core/types/src/types/array.ts:21

Properties

`Optional` maxItems

maxItems?: number

`Optional` minItems

minItems?: number

`Readonly` values

values: T

Accessors

identifier

get identifier(): string
Returns string
Overrides TypeInformation.identifier
- Defined in packages/core/types/src/types/array.ts:80

Methods

check

check<U>(value): Extends<U, PrimitiveType<T>[]>
Checks if the given value is of the type defined by this type information
Type Parameters
- U
Parameters
- value: U
  The value to check
Returns Extends<U, PrimitiveType<T>[]>
Overrides TypeInformation.check
- Defined in packages/core/types/src/types/array.ts:36

checkError

checkError(value): undefined | string
Returns the check-error for the given value
Parameters
- value: unknown
  The value to check
Returns undefined | string
The error if the value is not of the type defined by this type information
Overrides TypeInformation.checkError
- Defined in packages/core/types/src/types/array.ts:46

exportToJson

exportToJson(value): JsonCompatible
Parameters
- value: PrimitiveType<T>[]
Returns JsonCompatible
Overrides TypeInformation.exportToJson
- Defined in packages/core/types/src/types/array.ts:105

exportToString

exportToString(value): string
Parameters
- value: PrimitiveType<T>[]
Returns string
Overrides TypeInformation.exportToString
- Defined in packages/core/types/src/types/array.ts:84

importFromJson

importFromJson(value): PrimitiveType<T>[]
Parameters
- value: JsonCompatible
Returns PrimitiveType<T>[]
Overrides TypeInformation.importFromJson
- Defined in packages/core/types/src/types/array.ts:109

importFromString

importFromString(value): PrimitiveType<T>[]
Parameters
- value: string
Returns PrimitiveType<T>[]
Overrides TypeInformation.importFromString
- Defined in packages/core/types/src/types/array.ts:97

json

json(): {
    maxItems: undefined | number;
    minItems: undefined | number;
    type: string;
    values: unknown;
}
Returns {
    maxItems: undefined | number;
    minItems: undefined | number;
    type: string;
    values: unknown;
}
- maxItems: undefined | number
- minItems: undefined | number
- type: string
- values: unknown
Overrides TypeInformation.json
- Defined in packages/core/types/src/types/array.ts:121

sendableVia

sendableVia(): SendMethod[]
Get a list of methods that can be used to send this type to the server

Returns SendMethod[]
Overrides TypeInformation.sendableVia
- Defined in packages/core/types/src/types/array.ts:71
sendableVia(m): boolean
Checks if the given method can be used to send this type to the server
Parameters
- m: SendMethod
  The method to check
Returns boolean
Overrides TypeInformation.sendableVia
- Defined in packages/core/types/src/types/array.ts:72

toString

toString(): string
Returns string
- Defined in packages/core/types/src/types/array.ts:117

Generated using TypeDoc