Welshman

Appearance

Welshman Docs / @welshman/app / Publication

Class: Publication ​

Defined in: plugins/publisher.ts:144

One event on its way to a set of relays. The Publisher moves it with advance.

Extends ​

Constructors ​

Constructor ​

new Publication(request, event): Publication

Defined in: plugins/publisher.ts:156

Parameters ​

request ​

PublishRequest

event ​

HashedEvent

Returns ​

Publication

Overrides ​

PublishStatusView.constructor

Properties ​

controller ​

readonly controller: AbortController

Defined in: plugins/publisher.ts:152

event ​

event: HashedEvent

Defined in: plugins/publisher.ts:148

request ​

readonly request: PublishRequest

Defined in: plugins/publisher.ts:157

state ​

state: PublicationState

Defined in: plugins/publisher.ts:145

wrap? ​

optional wrap?: HashedEvent

Defined in: plugins/publisher.ts:150

Accessors ​

relays ​

Get Signature ​

get relays(): string[]

Defined in: plugins/publisher.ts:165

Returns ​

string[]

Overrides ​

PublishStatusView.relays

results ​

Get Signature ​

get results(): PublishResultsByRelay

Defined in: plugins/publisher.ts:169

Returns ​

PublishResultsByRelay

Overrides ​

PublishStatusView.results

signal ​

Get Signature ​

get signal(): AbortSignal

Defined in: plugins/publisher.ts:173

Returns ​

AbortSignal

Methods ​

abort() ​

abort(): void

Defined in: plugins/publisher.ts:199

Returns ​

void

Overrides ​

PublishStatusView.abort

advance() ​

advance(state, draft?): void

Defined in: plugins/publisher.ts:181

Parameters ​

state ​

PublicationState

draft? ​
event ​

HashedEvent

wrap? ​

HashedEvent

Returns ​

void

canAbort() ​

canAbort(): boolean

Defined in: plugins/publisher.ts:130

Returns ​

boolean

Inherited from ​

PublishStatusView.canAbort

getCompleteUrls() ​

getCompleteUrls(): string[]

Defined in: plugins/publisher.ts:113

Returns ​

string[]

Inherited from ​

PublishStatusView.getCompleteUrls

getError() ​

getError(): Promise<string | undefined>

Defined in: plugins/publisher.ts:135

Returns ​

Promise<string | undefined>

Inherited from ​

PublishStatusView.getError

getFailedUrls() ​

getFailedUrls(): string[]

Defined in: plugins/publisher.ts:121

Returns ​

string[]

Inherited from ​

PublishStatusView.getFailedUrls

getIncompleteUrls() ​

getIncompleteUrls(): string[]

Defined in: plugins/publisher.ts:117

Returns ​

string[]

Inherited from ​

PublishStatusView.getIncompleteUrls

getUrlsWithStatus() ​

getUrlsWithStatus(statuses): string[]

Defined in: plugins/publisher.ts:103

Parameters ​

statuses ​

PublishStatus | PublishStatus[]

Returns ​

string[]

Inherited from ​

PublishStatusView.getUrlsWithStatus

hasStatus() ​

hasStatus(statuses): boolean

Defined in: plugins/publisher.ts:125

Parameters ​

statuses ​

PublishStatus | PublishStatus[]

Returns ​

boolean

Inherited from ​

PublishStatusView.hasStatus

isComplete() ​

isComplete(): boolean

Defined in: plugins/publisher.ts:177

Returns ​

boolean

Overrides ​

PublishStatusView.isComplete

notify() ​

protected notify(): void

Defined in: plugins/publisher.ts:93

Returns ​

void

Inherited from ​

PublishStatusView.notify

settled() ​

settled(): Deferred<Publication, Publication>

Defined in: plugins/publisher.ts:214

Returns ​

Deferred<Publication, Publication>

Overrides ​

PublishStatusView.settled

subscribe() ​

subscribe(subscriber): () => void

Defined in: plugins/publisher.ts:81

Parameters ​

subscriber ​

Subscriber<Publication>

Returns ​

() => void

Inherited from ​

PublishStatusView.subscribe