Class Pledge<T>

A lightweight wrapper around Promises (utilizing Promise.withResolvers) that exposes resolve, reject, and state-tracking methods. Useful for deferred execution and managing asynchronous lifecycles.

Example

const p = new Pledge`<string>`('MyPledge');
p.resolve('Success!');
await p.promise; // 'Success!'

Type Parameters

Index

Constructors

constructor

new Pledge<T>(arg?: string | Pledge.Constructor): Pledge<T>
Creates a new Pledge instance.
Type Parameters
- T
Parameters
- Optionalarg: string | Pledge.Constructor
  An optional configuration object or string tag
Returns Pledge<T>
- Defined in packages/library/src/common/pledge.class.ts:81

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
- Defined in packages/library/src/common/pledge.class.ts:124

isPending

get isPending(): boolean
Returns boolean
- Defined in packages/library/src/common/pledge.class.ts:151

isRejected

get isRejected(): boolean
Returns boolean
- Defined in packages/library/src/common/pledge.class.ts:157

isResolved

get isResolved(): boolean
Returns boolean
- Defined in packages/library/src/common/pledge.class.ts:154

isSettled

get isSettled(): boolean
Returns boolean
- Defined in packages/library/src/common/pledge.class.ts:160

promise

get promise(): Promise<T>
Returns Promise<T>
- Defined in packages/library/src/common/pledge.class.ts:143

state

get state(): string | undefined
Returns string | undefined
- Defined in packages/library/src/common/pledge.class.ts:147

status

get status(): Status<T>
Returns Status<T>
- Defined in packages/library/src/common/pledge.class.ts:139

`Static`STATE

get STATE(): { Pending: symbol; Rejected: symbol; Resolved: symbol }
Returns { Pending: symbol; Rejected: symbol; Resolved: symbol }
- Defined in packages/library/src/common/pledge.class.ts:41

`Static`status

get status(): Status<typeof Pledge>
Returns Status<typeof Pledge>
- Defined in packages/library/src/common/pledge.class.ts:72

Methods

[dispose]

"[dispose]"(): void
Returns void
- Defined in packages/library/src/common/pledge.class.ts:128

reject

reject(error: any): Promise<T>
Rejects the underlying promise.
Parameters
- error: any
  The reason for rejection
Returns Promise<T>
The internal promise
- Defined in packages/library/src/common/pledge.class.ts:192

resolve

resolve(value: T): Promise<T>
Resolves the underlying promise.
Parameters
- value: T
  The value to resolve the promise with
Returns Promise<T>
The internal promise
- Defined in packages/library/src/common/pledge.class.ts:174

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
): Promise<TResult1 | TResult2>
Makes the Pledge 'then-able', allowing it to be directly awaited or chained like a standard Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | null
  Callback for when the pledge resolves
- Optionalonrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null
  Callback for when the pledge rejects
Returns Promise<TResult1 | TResult2>
A new promise representing the chained execution
- Defined in packages/library/src/common/pledge.class.ts:212

toString

toString(): string
Returns string
- Defined in packages/library/src/common/pledge.class.ts:164

`Static`[dispose]

"[dispose]"(): void
reset static defaults

Returns void
- Defined in packages/library/src/common/pledge.class.ts:70

`Static`init

init(arg?: string | Pledge.Constructor): Status<typeof Pledge>
Initializes global defaults for all future Pledge instances.
Parameters
- Optionalarg: string | Pledge.Constructor
  The global configuration or tag
Returns Status<typeof Pledge>
The updated static status configuration
- Defined in packages/library/src/common/pledge.class.ts:49

Class Pledge<T>

Example

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Pledge<T>

Accessors

[toStringTag]

Returns string

isPending

Returns boolean

isRejected

Returns boolean

isResolved

Returns boolean

isSettled

Returns boolean

promise

Returns Promise<T>

state

Returns string | undefined

status

Returns Status<T>

StaticSTATE

Returns { Pending: symbol; Rejected: symbol; Resolved: symbol }

Staticstatus

Returns Status<typeof Pledge>

Methods

[dispose]

Returns void

reject

Parameters

Returns Promise<T>

resolve

Parameters

Returns Promise<T>

then

Type Parameters

Parameters

Returns Promise<TResult1 | TResult2>

toString

Returns string

Static[dispose]

Returns void

Staticinit

Parameters

Returns Status<typeof Pledge>

Settings

On This Page

`Static`STATE

`Static`status

`Static`[dispose]

`Static`init