validation | @overturebio-stack/lectern-client

Index

Type aliases

TypedValidationFunction

TypedValidationFunction: (rec: TypedDataRecord, index: number, fields: Array<FieldDefinition>) => Array<SchemaValidationError>

Type declaration

- (rec: TypedDataRecord, index: number, fields: Array<FieldDefinition>): Array<SchemaValidationError>
- Parameters
  - rec: TypedDataRecord
  - index: number
  - fields: Array<FieldDefinition>
  Returns Array<SchemaValidationError>

ValidationFunction

ValidationFunction: (rec: DataRecord, index: number, fields: Array<FieldDefinition>) => Array<SchemaValidationError>

Type declaration

- (rec: DataRecord, index: number, fields: Array<FieldDefinition>): Array<SchemaValidationError>
- Parameters
  - rec: DataRecord
  - index: number
  - fields: Array<FieldDefinition>
  Returns Array<SchemaValidationError>

Variables

Const ctx

ctx: Context = vm.createContext()

Functions

Const buildError

buildError(errorType: SchemaValidationErrorTypes, fieldName: string, index: number, info?: object): SchemaValidationError

- Defined in src/schema-functions.ts:652
Parameters
- errorType: SchemaValidationErrorTypes
- fieldName: string
- index: number
- Default value info: object = {}
Returns SchemaValidationError

Const getScript

getScript(scriptString: string): Script

- Defined in src/schema-functions.ts:647
Parameters
- scriptString: string
Returns Script

Const getValidFields

getValidFields(errs: ReadonlyArray<SchemaValidationError>, fields: ReadonlyArray<FieldDefinition>): FieldDefinition[]

- Defined in src/schema-functions.ts:528
Parameters
- errs: ReadonlyArray<SchemaValidationError>
- fields: ReadonlyArray<FieldDefinition>
Returns FieldDefinition[]

Const isInvalidEnumValue

isInvalidEnumValue(codeList: CodeListRestriction, value: string | boolean | number | undefined): boolean

- Defined in src/schema-functions.ts:573
Parameters
- codeList: CodeListRestriction
- value: string | boolean | number | undefined
Returns boolean

Const isInvalidFieldType

isInvalidFieldType(valueType: ValueType, value: string): boolean

- Defined in src/schema-functions.ts:538
Parameters
- valueType: ValueType
- value: string
Returns boolean

Const isInvalidRegexValue

isInvalidRegexValue(regex: string, value: string): boolean

- Defined in src/schema-functions.ts:582
Parameters
- regex: string
- value: string
Returns boolean

Const isOutOfRange

isOutOfRange(range: RangeRestriction, value: number | undefined): boolean

- Defined in src/schema-functions.ts:561
Parameters
- range: RangeRestriction
- value: number | undefined
Returns boolean

Const isRequiredMissing

isRequiredMissing(field: FieldDefinition, record: DataRecord): boolean

- Defined in src/schema-functions.ts:553
Parameters
- field: FieldDefinition
- record: DataRecord
Returns boolean

Const runValidationPipeline

runValidationPipeline(rec: DataRecord | TypedDataRecord, index: number, fields: ReadonlyArray<FieldDefinition>, funs: Array<ValidationFunction | TypedValidationFunction>): SchemaValidationError[]

- Defined in src/schema-functions.ts:350
Parameters
- rec: DataRecord | TypedDataRecord
- index: number
- fields: ReadonlyArray<FieldDefinition>
- funs: Array<ValidationFunction | TypedValidationFunction>
Returns SchemaValidationError[]

Const validateEnum

validateEnum(rec: TypedDataRecord, index: number, fields: Array<FieldDefinition>): SchemaValidationError[]

- Defined in src/schema-functions.ts:440
Parameters
- rec: TypedDataRecord
- index: number
- fields: Array<FieldDefinition>
Returns SchemaValidationError[]

Const validateFieldNames

validateFieldNames(record: Readonly<DataRecord>, index: number, fields: Array<FieldDefinition>): SchemaValidationError[]

- Defined in src/schema-functions.ts:497
Parameters
- record: Readonly<DataRecord>
- index: number
- fields: Array<FieldDefinition>
Returns SchemaValidationError[]

Const validateNonArrayFields

validateNonArrayFields(record: Readonly<DataRecord>, index: number, fields: Array<FieldDefinition>): SchemaValidationError[]

- Defined in src/schema-functions.ts:513
Parameters
- record: Readonly<DataRecord>
- index: number
- fields: Array<FieldDefinition>
Returns SchemaValidationError[]

Const validateRange

validateRange(rec: TypedDataRecord, index: number, fields: ReadonlyArray<FieldDefinition>): SchemaValidationError[]

- Defined in src/schema-functions.ts:397
Parameters
- rec: TypedDataRecord
- index: number
- fields: ReadonlyArray<FieldDefinition>
Returns SchemaValidationError[]

Const validateRegex

validateRegex(rec: TypedDataRecord, index: number, fields: ReadonlyArray<FieldDefinition>): SchemaValidationError[]

- Defined in src/schema-functions.ts:371
Parameters
- rec: TypedDataRecord
- index: number
- fields: ReadonlyArray<FieldDefinition>
Returns SchemaValidationError[]

Const validateRequiredFields

validateRequiredFields(rec: DataRecord, index: number, fields: Array<FieldDefinition>): SchemaValidationError[]

- Defined in src/schema-functions.ts:482
Parameters
- rec: DataRecord
- index: number
- fields: Array<FieldDefinition>
Returns SchemaValidationError[]

Const validateScript

validateScript(rec: TypedDataRecord, index: number, fields: Array<FieldDefinition>): SchemaValidationError[]

- Defined in src/schema-functions.ts:420
Parameters
- rec: TypedDataRecord
- index: number
- fields: Array<FieldDefinition>
Returns SchemaValidationError[]

Const validateValueTypes

validateValueTypes(rec: DataRecord, index: number, fields: Array<FieldDefinition>): SchemaValidationError[]

- Defined in src/schema-functions.ts:462
Parameters
- rec: DataRecord
- index: number
- fields: Array<FieldDefinition>
Returns SchemaValidationError[]

Const validateWithScript

validateWithScript(field: FieldDefinition, record: TypedDataRecord): { message: string; valid: boolean }

- Defined in src/schema-functions.ts:591
Parameters
- field: FieldDefinition
- record: TypedDataRecord
Returns { message: string; valid: boolean }
- message: string
- valid: boolean

Generated using TypeDoc

Index

Type aliases

Variables

Functions

Type aliases

TypedValidationFunction

Type declaration

Parameters

rec: TypedDataRecord

index: number

fields: Array<FieldDefinition>

Returns Array<SchemaValidationError>

ValidationFunction

Type declaration

Parameters

rec: DataRecord

index: number

fields: Array<FieldDefinition>

Returns Array<SchemaValidationError>

Variables

Const ctx

Functions

Const buildError

Parameters

errorType: SchemaValidationErrorTypes

fieldName: string

index: number

Default value info: object = {}

Returns SchemaValidationError

Const getScript

Parameters

scriptString: string

Returns Script

Const getValidFields

Parameters

errs: ReadonlyArray<SchemaValidationError>

fields: ReadonlyArray<FieldDefinition>

Returns FieldDefinition[]

Const isInvalidEnumValue

Parameters

codeList: CodeListRestriction

value: string | boolean | number | undefined

Returns boolean

Const isInvalidFieldType

Parameters

valueType: ValueType

value: string

Returns boolean

Const isInvalidRegexValue

Parameters

regex: string

value: string

Returns boolean

Const isOutOfRange

Parameters

range: RangeRestriction

value: number | undefined

Returns boolean

Const isRequiredMissing

Parameters

field: FieldDefinition

record: DataRecord

Returns boolean

Const runValidationPipeline

Parameters

rec: DataRecord | TypedDataRecord

index: number

fields: ReadonlyArray<FieldDefinition>

funs: Array<ValidationFunction | TypedValidationFunction>

Returns SchemaValidationError[]

Const validateEnum

Parameters

rec: TypedDataRecord

index: number

fields: Array<FieldDefinition>

Returns SchemaValidationError[]

Const validateFieldNames

Parameters

record: Readonly<DataRecord>

index: number