AsyncResource | @rds/sdk

An asyncronous resource that can be resolved.

Hierarchy

AsyncResource
- RdsDataProduct
- RdsCatalog

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AsyncResource(resolve: boolean): AsyncResource

- Defined in src/models/async/async-resource.ts:12
Create a new AsyncResource

Parameters
- resolve: boolean
  
  whether to resolve the resource now, defaults to false
Returns AsyncResource

Properties

Private resolutionListeners

resolutionListeners: ResolutionListener[] = []

Array of resolution listeners

Private resolved

resolved: boolean = false

Whether this resource is resolved

Private resolving

resolving: boolean = false

Whether this resource is resolving

Methods

isResolved

isResolved(): boolean

- Defined in src/models/async/async-resource.ts:26
Returns boolean

whether this resource is resolved

isResolving

isResolving(): boolean

- Defined in src/models/async/async-resource.ts:31
Returns boolean

whether this resource is resolving

registerResolutionListener

registerResolutionListener(listener: ResolutionListener): void

- Defined in src/models/async/async-resource.ts:39
Register a listener that will emit when this resource has been resolved sucessfully.

Parameters
- listener: ResolutionListener
  
  the listener for when this resource has been resolved
Returns void

Abstract resolve

resolve(): Promise<void>

- Defined in src/models/async/async-resource.ts:48
Resolve this resource.

Returns Promise<void>

a promise that completes once the resource is resolved

Protected setResolved

setResolved(resolved: boolean): void

- Defined in src/models/async/async-resource.ts:54
Setter for resolved.

Parameters
- resolved: boolean
  
  whether this resource is resolved
Returns void

Protected setResolving

setResolving(resolving: boolean): void

- Defined in src/models/async/async-resource.ts:69
Setter for resolving.

Parameters
- resolving: boolean
  
  whether the resource is resolving
Returns void

Generated using TypeDoc