A context.
The origin of the federated server, including the scheme (http://
or
https://
) and the host (e.g., example.com:8080
).
The host of the federated server, including the hostname
(e.g., example.com
) and the port following a colon (e.g., :8080
)
if it is not the default port for the scheme.
The hostname of the federated server (e.g., example.com
). This is
the same as the host without the port.
data: TContextData
The user-defined data associated with the context.
documentLoader: DocumentLoader
The document loader for loading remote JSON-LD documents.
contextLoader: DocumentLoader
The context loader for loading remote JSON-LD contexts.
Builds the URI of the NodeInfo document.
getActorUri(identifier: string): URL
Builds the URI of an actor with the given identifier.
getObjectUri<TObject extends Object>(): URL
Builds the URI of an object with the given class and values.
getOutboxUri(identifier: string): URL
Builds the URI of an actor's outbox with the given identifier.
getInboxUri(): URL
Builds the URI of the shared inbox.
getInboxUri(identifier: string): URL
Builds the URI of an actor's inbox with the given identifier.
getFollowingUri(identifier: string): URL
Builds the URI of an actor's following collection with the given identifier.
getFollowersUri(identifier: string): URL
Builds the URI of an actor's followers collection with the given identifier.
getLikedUri(identifier: string): URL
Builds the URI of an actor's liked collection with the given identifier.
getFeaturedUri(identifier: string): URL
Builds the URI of an actor's featured collection with the given identifier.
getFeaturedTagsUri(identifier: string): URL
Builds the URI of an actor's featured tags collection with the given identifier.
parseUri(uri: URL | null): ParseUriResult | null
Determines the type of the URI and extracts the associated data.
getActorKeyPairs(identifier: string): Promise<ActorKeyPair[]>
Gets the key pairs for an actor.
getDocumentLoader(identity: ): Promise<DocumentLoader>
Gets an authenticated DocumentLoader for the given identity. Note that an authenticated document loader intentionally does not cache the fetched documents.
getDocumentLoader(identity: { keyId: URL; privateKey: CryptoKey; }): DocumentLoader
Gets an authenticated DocumentLoader for the given identity. Note that an authenticated document loader intentionally does not cache the fetched documents.
lookupObject(options?: LookupObjectOptions,): Promise<Object | null>
Looks up an ActivityStreams object by its URI (including acct:
URIs)
or a fediverse handle (e.g., @user@server
or user@server
).
traverseCollection(collection: Collection,options?: TraverseCollectionOptions,): AsyncIterable<Object | Link>
Traverses a collection, yielding each item in the collection. If the collection is paginated, it will fetch the next page automatically.
sendActivity(sender: SenderKeyPair
| SenderKeyPair[]
| { identifier: string; }
| { username: string; }
| { handle: string; },activity: Activity,options?: SendActivityOptions,): Promise<void>
Sends an activity to recipients' inboxes.
sendActivity(): Promise<void>
Sends an activity to the outboxes of the sender's followers.