Class Validator

Zod based validator for Nostr Relay messages

Index

Constructors

Methods

getEventSchema getFilterSchema getFiltersSchema getIncomingMessageSchema validateEvent validateFilter validateFilters validateIncomingMessage

Constructors

constructor

new Validator(options?): Validator
Create a new validator
Parameters
- options: ValidatorOptions = {}
  Validator options
Returns Validator
- Defined in validator.ts:25

Methods

getEventSchema

getEventSchema(): ZodType<Event, ZodTypeDef, Event>
Get event schema

Returns ZodType<Event, ZodTypeDef, Event>
- Defined in validator.ts:102

getFilterSchema

getFilterSchema(): ZodType<Filter, ZodTypeDef, Filter>
Get filter schema

Returns ZodType<Filter, ZodTypeDef, Filter>
- Defined in validator.ts:88

getFiltersSchema

getFiltersSchema(): ZodType<Filter[], ZodTypeDef, Filter[]>
Get filters schema

Returns ZodType<Filter[], ZodTypeDef, Filter[]>
- Defined in validator.ts:95

getIncomingMessageSchema

getIncomingMessageSchema(): ZodType<IncomingMessage, ZodTypeDef, IncomingMessage>
Get incoming message schema

Returns ZodType<IncomingMessage, ZodTypeDef, IncomingMessage>
- Defined in validator.ts:81

validateEvent

validateEvent(data): Promise<Event>
Validate event
Parameters
- data: RawData
  data to validate
Returns Promise<Event>
- Defined in validator.ts:72

validateFilter

validateFilter(data): Promise<Filter>
Validate filter
Parameters
- data: RawData
  data to validate
Returns Promise<Filter>
- Defined in validator.ts:50

validateFilters

validateFilters(data): Promise<Filter[]>
Validate filters
Parameters
- data: RawData
  data to validate
Returns Promise<Filter[]>
- Defined in validator.ts:61

validateIncomingMessage

validateIncomingMessage(data): Promise<IncomingMessage>
Validate incoming message
Parameters
- data: RawData
  data to validate
Returns Promise<IncomingMessage>
- Defined in validator.ts:38