Options
All
  • Public
  • Public/Protected
  • All
Menu

Metal Event

Index

Enumerations

Classes

Type aliases

Functions

Type aliases

ClientMessage

ClientMessage<T>: { data: ClientRequest<T> | ClientSubscription; type: "request" | "subscription"; uuid: string }

Type parameters

  • T

Type declaration

ClientRequest

ClientRequest<T>: { data?: T; headers?: RequestHeaders; method: RequestMethod; url: string }

Type parameters

  • T

Type declaration

ClientSubscription

ClientSubscription: { filters?: QueryFilter; headers?: RequestHeaders; method: "subscribe" | "unsubscribe"; url: string }

Type declaration

ConnectionQuery

ConnectionQuery: { clientId: string; reconnect?: boolean }

Type declaration

  • clientId: string
  • Optional reconnect?: boolean

EventHandler

EventHandler<T>: (...events: T[]) => void

Type parameters

  • T

Type declaration

    • (...events: T[]): void

    • Parameters

      • Rest ...events: T[]

      Returns void

JSONBody

JSONBody: {}

Type declaration

  • [key: string]: any

LoggerConfig

LoggerConfig: { level: LogLevel }

Type declaration

MessageBody

MessageBody: string | number | JSONBody | any[]

QueryFilter

QueryFilter: WhereFilter | WhereFilter[]

RequestHandler

RequestHandler<R, D>: (req: Request<R>, res: Response<D>) => void | Promise<void>

Type parameters

  • R

  • D

Type declaration

RequestHeaders

RequestHeaders: {}

Type declaration

  • [key: string]: string

RequestMethod

RequestMethod: "post" | "get" | "put" | "patch" | "delete" | "options" | "subscribe" | "unsubscribe"

RequestMiddleware

RequestMiddleware: (req: Request<any>, res: Response<any>) => void | Promise<void>

Type declaration

RequestRoute

RequestRoute<R, D>: { params: RouteParams; query: RouteQuery; route: Route<R, D> }

Type parameters

  • R

  • D

Type declaration

RouteParams

RouteParams: {}

Type declaration

  • [key: string]: string | number | boolean

RouteQuery

RouteQuery: {}

Type declaration

  • [key: string]: string | number | boolean | object | any[]

ServerConfig

ServerConfig: { keepAlive?: number; logLevel?: LogLevel; publishChanges?: boolean }

Type declaration

  • Optional keepAlive?: number
  • Optional logLevel?: LogLevel
  • Optional publishChanges?: boolean

ServerEvent

ServerEvent<T>: { data?: T; filters?: QueryFilter; path: string; referer?: ServerEvent<any>; type: ServerEventType }

Type parameters

  • T

Type declaration

ServerEventType

ServerEventType: RequestMethod | "touch"

ServerMessage

ServerMessage<T>: { data: ServerResponse<T> | ServerEvent<T>; type: "response" | "event"; uuid: string }

Type parameters

  • T

Type declaration

ServerResponse

ServerResponse<T>: { data?: T; headers?: RequestHeaders; status: number; statusText: string }

Type parameters

  • T

Type declaration

  • Optional data?: T
  • Optional headers?: RequestHeaders
  • status: number
  • statusText: string

Subscribers

Subscribers: Subscription[]

Unsubscribe

Unsubscribe: () => void

Type declaration

    • (): void

    • Returns void

UserContext

UserContext: { client: WebSocket; clientId: string }

Type declaration

  • client: WebSocket
  • clientId: string

UserSubscription

UserSubscription: { filters?: QueryFilter; user: User }

Type declaration

Users

Users: {}

Type declaration

  • [id: string]: User

ValueType

ValueType: string | number | null | Date

WhereCondition

WhereCondition: { between?: [number, number]; eq?: any; gt?: number; gte?: number; inq?: ValueType[]; like?: string; lt?: number; lte?: number; neq?: any; nin?: ValueType[] }

Type declaration

  • Optional between?: [number, number]
  • Optional eq?: any
  • Optional gt?: number
  • Optional gte?: number
  • Optional inq?: ValueType[]
  • Optional like?: string
  • Optional lt?: number
  • Optional lte?: number
  • Optional neq?: any
  • Optional nin?: ValueType[]

WhereFilter

WhereFilter: {}

Type declaration

Functions

match

matchAll

  • matchAll(data?: object, filter?: WhereFilter): boolean

matchAny

  • matchAny(data?: object, filter?: WhereFilter[]): boolean

Generated using TypeDoc