Class Documents

Hierarchy (view full)

EventEmitter<DocumentsEvents>
- Documents

Index

Constructors

Properties

Methods

fetch off on once open

Constructors

constructor

new Documents(gp): Documents
Parameters
- gp: CoreSDK
Returns Documents
Overrides EventEmitter.constructor
- Defined in core/Documents/Documents.ts:17

Properties

`Private` _events

_events: EventLite = ...

`Private` gp

Methods

fetch

fetch(__namedParameters): Promise<Document>
Parameters
- __namedParameters: FetchDocumentInput
Returns Promise<Document>
- Defined in core/Documents/Documents.ts:46

off

off<ET>(type, handler): void
Type Parameters
- ET extends keyof DocumentsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: DocumentsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12

on

on<ET>(type, handler): void
Type Parameters
- ET extends keyof DocumentsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: DocumentsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9

once

once<ET>(type, handler): void
Type Parameters
- ET extends keyof DocumentsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: DocumentsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15

open

open(__namedParameters): Promise<void>
Parameters
- __namedParameters: Omit<FetchDocumentInput, "format">
Returns Promise<void>
- Defined in core/Documents/Documents.ts:21