Class ParameterValidationError

Provides an error interface for handling when a function call has invalid parameters.

Hierarchy

ParameterValidationError

Implements

Error

Index

Constructors

constructor

Properties

Constructors

constructor

new ParameterValidationError(paramIndex: number, expectedSchema: JSONSchema, receievedParam: any, errors: ErrorObject[]): ParameterValidationError

- Defined in node_modules/@open-rpc/schema-utils-js/build/src/method-call-validator/parameter-validation-error.d.ts:12
Parameters
- paramIndex: number
  
  The index of the param that for this error (index of the param in MethodObject.params).
- expectedSchema: JSONSchema
  
  The expected JSON Schema for the passed in value.
- receievedParam: any
  
  The value of the param passed to the method call.
- errors: ErrorObject[]
  
  The errors recieved by ajv
Returns ParameterValidationError

Properties

expectedSchema

expectedSchema: JSONSchema

message

message: string

name

name: string

paramIndex

paramIndex: number

receievedParam

receievedParam: any