Class BaseResource

constructor

• new BaseResource(): BaseResource

  Returns BaseResource

Static Optionalconnection

Static Optionalitem

Staticclone

• clone<T extends typeof BaseResource = typeof BaseResource>(
      options?: Partial<NgwResourceOptions>,
  ): T

  Type Parameters

  • T extends typeof BaseResource = typeof BaseResource

  Parameters

  • options: Partial<NgwResourceOptions> = {}

  Returns T

Staticconnect

• connect<T extends typeof BaseResource = typeof BaseResource>(
      resourceOptions: ResourceIdKeynameDef,
      connectionOrOptions: Connection | ConnectionOptions,
  ): Promise<T>

  Type Parameters

  • T extends typeof BaseResource = typeof BaseResource

  Parameters

  • resourceOptions: ResourceIdKeynameDef
  • connectionOrOptions: Connection | ConnectionOptions

  Returns Promise<T>

StaticgetNgwPayload

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

  Parameters

  • resource: Type<BaseResource>
  • parent: number
  • options: SyncOptions

  Returns undefined | Record<string, any>

Staticreceive

• receive(item: CompositeRead, ResCls?: typeof BaseResource): typeof BaseResource

  Parameters

  • item: CompositeRead
  • OptionalResCls: typeof BaseResource

  Returns typeof BaseResource

Staticsync

• sync(
      options: SyncOptions,
      connectionOrOptions: Connection | ConnectionOptions,
  ): void

  Parameters

  • options: SyncOptions
  • connectionOrOptions: Connection | ConnectionOptions

  Returns void

StatictoTypescript

• toTypescript(opt?: ToTypescriptOptions): ToTypescript

  Parameters

  • Optionalopt: ToTypescriptOptions

  Returns ToTypescript

Staticvalidate

• validate(): ValidateErrorType[]

  Returns ValidateErrorType[]