Class BaseResource

constructor

• new BaseResource(): BaseResource

• Returns BaseResource

Static Optional connection

Static Optional item

Static clone

• clone<T>(options?): T

• Type Parameters

  • T extends typeof BaseResource = typeof BaseResource

  Parameters

  • options: Partial<NgwResourceOptions> = {}

  Returns T

Static connect

• connect<T>(resourceOptions, connectionOrOptions): Promise<T>

• Type Parameters

  • T extends typeof BaseResource = typeof BaseResource

  Parameters

  • resourceOptions: ResourceIdKeynameDef

  • connectionOrOptions: ConnectionOptions | Connection

  Returns Promise<T>

Static getNgwPayload

• getNgwPayload(resource, parent, options): undefined | Record<string, any>

• Parameters

  • resource: Type<BaseResource>

  • parent: number

  • options: SyncOptions

  Returns undefined | Record<string, any>

Static receive

• receive(item, ResCls?): typeof BaseResource

• Parameters

  • item: ResourceItem

  • Optional ResCls: typeof BaseResource

  Returns typeof BaseResource

Static sync

• sync(options, connectionOrOptions): void

• Parameters

  • options: SyncOptions

  • connectionOrOptions: ConnectionOptions | Connection

  Returns void

Static toTypescript

• toTypescript(opt?): ToTypescript

• Parameters

  • Optional opt: ToTypescriptOptions

  Returns ToTypescript

Static validate

• validate(): ValidateErrorType[]

• Returns ValidateErrorType[]