tsky

Appearance

agent

@tsky/client / agent / FeedGenerator

FeedGenerator ​

Defined in: client/src/agent.ts:725

Constructors ​

new FeedGenerator() ​

ts
new FeedGenerator(client): FeedGenerator

Defined in: client/src/agent.ts:726

Parameters ​

client ​

Client

Returns ​

FeedGenerator

Properties ​

client ​

ts
client: Client;

Defined in: client/src/agent.ts:726

Methods ​

describe() ​

ts
describe(options): Promise<Output>

Defined in: client/src/agent.ts:731

Get information about a feed generator, including policies and offered feed URIs. Does not require auth; implemented by Feed Generator services (not App View).

Parameters ​

options ​

RPCOptions = {}

Returns ​

Promise<Output>

feed() ​

Call Signature ​

ts
feed(feed, options): Promise<Output>

Defined in: client/src/agent.ts:740

Get information about a feed generator. Implemented by AppView.

Parameters ​
feed ​

string

options ​

RPCOptions

Returns ​

Promise<Output>

Call Signature ​

ts
feed(feeds, options): Promise<GeneratorView[]>

Defined in: client/src/agent.ts:747

Get information about a list of feed generators.

Parameters ​
feeds ​

string[]

options ​

RPCOptions

Returns ​

Promise<GeneratorView[]>

skeleton() ​

ts
skeleton(params, options): Promise<Paginator<Output>>

Defined in: client/src/agent.ts:777

Get a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester. Implemented by Feed Generator Service.

Parameters ​

params ​

Params

options ​

RPCOptions = {}

Returns ​

Promise<Paginator<Output>>