Welshman Docs / @welshman/app / Thunk

Class: Thunk

Defined in: app/src/plugins/thunk.ts:122

Shared base for Thunk and MergedThunk: a subscribable bag of per-relay publish results.

Extends

• BaseThunk

Constructors

Constructor

new Thunk(options): Thunk

Defined in: app/src/plugins/thunk.ts:128

Parameters

options

ThunkOptions

Returns

Thunk

Overrides

BaseThunk.constructor

Properties

_subs

_subs: Subscriber<any>[] = []

Defined in: app/src/plugins/thunk.ts:36

Inherited from

BaseThunk._subs

---

complete

complete: Deferred<void, void>

Defined in: app/src/plugins/thunk.ts:124

---

controller

controller: AbortController

Defined in: app/src/plugins/thunk.ts:125

---

event

event: HashedEvent

Defined in: app/src/plugins/thunk.ts:123

---

options

readonly options: ThunkOptions

Defined in: app/src/plugins/thunk.ts:128

---

results

results: PublishResultsByRelay = {}

Defined in: app/src/plugins/thunk.ts:37

Inherited from

BaseThunk.results

---

wrap?

optional wrap: SignedEvent

Defined in: app/src/plugins/thunk.ts:126

Accessors

user

Get Signature

get user(): User

Defined in: app/src/plugins/thunk.ts:156

Returns

User

Methods

_fail()

_fail(detail): void

Defined in: app/src/plugins/thunk.ts:160

Parameters

detail

string

Returns

void

---

_notify()

_notify(): void

Defined in: app/src/plugins/thunk.ts:41

Returns

void

Inherited from

BaseThunk._notify

---

_publish()

_publish(event): Promise<void>

Defined in: app/src/plugins/thunk.ts:190

Parameters

event

SignedEvent

Returns

Promise<void>

---

_setAborted()

_setAborted(result): void

Defined in: app/src/plugins/thunk.ts:184

Parameters

result

PublishResult

Returns

void

---

_setPending()

_setPending(result): void

Defined in: app/src/plugins/thunk.ts:172

Parameters

result

PublishResult

Returns

void

---

_setTimeout()

_setTimeout(result): void

Defined in: app/src/plugins/thunk.ts:178

Parameters

result

PublishResult

Returns

void

---

abort()

abort(): void

Defined in: app/src/plugins/thunk.ts:303

Returns

void

Overrides

BaseThunk.abort

---

getCompleteUrls()

getCompleteUrls(): string[]

Defined in: app/src/plugins/thunk.ts:65

Returns

string[]

Inherited from

BaseThunk.getCompleteUrls

---

getError()

getError(): undefined | string

Defined in: app/src/plugins/thunk.ts:87

Returns

undefined | string

Inherited from

BaseThunk.getError

---

getFailedUrls()

getFailedUrls(): string[]

Defined in: app/src/plugins/thunk.ts:75

Returns

string[]

Inherited from

BaseThunk.getFailedUrls

---

getIncompleteUrls()

getIncompleteUrls(): string[]

Defined in: app/src/plugins/thunk.ts:71

Returns

string[]

Inherited from

BaseThunk.getIncompleteUrls

---

getUrlsWithStatus()

getUrlsWithStatus(statuses): string[]

Defined in: app/src/plugins/thunk.ts:57

Parameters

statuses

PublishStatus | PublishStatus[]

Returns

string[]

Inherited from

BaseThunk.getUrlsWithStatus

---

hasStatus()

hasStatus(statuses): boolean

Defined in: app/src/plugins/thunk.ts:79

Parameters

statuses

PublishStatus | PublishStatus[]

Returns

boolean

Inherited from

BaseThunk.hasStatus

---

isComplete()

isComplete(): boolean

Defined in: app/src/plugins/thunk.ts:83

Returns

boolean

Inherited from

BaseThunk.isComplete

---

publish()

publish(): Promise<void>

Defined in: app/src/plugins/thunk.ts:232

Returns

Promise<void>

---

subscribe()

subscribe(subscriber): () => void

Defined in: app/src/plugins/thunk.ts:47

Parameters

subscriber

Subscriber<Thunk>

Returns

(): void

Returns

void

Inherited from

BaseThunk.subscribe

---

waitForCompletion()

waitForCompletion(): Promise<void>

Defined in: app/src/plugins/thunk.ts:111

Returns

Promise<void>

Inherited from

BaseThunk.waitForCompletion

---

waitForError()

waitForError(): Promise<string>

Defined in: app/src/plugins/thunk.ts:99

Returns

Promise<string>

Inherited from

BaseThunk.waitForError