tsky

Appearance

agent

@tsky/client / agent / Actor

Actor ​

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

Extended by ​

Constructors ​

new Actor() ​

ts
new Actor(client, did): Actor

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

Parameters ​

client ​

Client

did ​

`did:${string}`

Returns ​

Actor

Properties ​

client ​

ts
client: Client;

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

did ​

ts
did: `did:${string}`;

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

Methods ​

feed() ​

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

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

Get a list of feeds (feed generator records) created by the actor (in the actor's repo).

Parameters ​

params? ​

Omit<Params, "actor">

options? ​

RPCOptions

Returns ​

Promise<Paginator<Output>>

feeds() ​

ts
feeds(limit?, options?): Promise<Paginator<Output>>

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

Get a view of an actor's 'author feed' (post and reposts by the author). Does not require auth.

Parameters ​

limit? ​

number

options? ​

RPCOptions

Returns ​

Promise<Paginator<Output>>

followers() ​

ts
followers(limit?, options?): Promise<Paginator<Output>>

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

Enumerates accounts which follow a specified account (actor).

Parameters ​

limit? ​

number

options? ​

RPCOptions = {}

Returns ​

Promise<Paginator<Output>>

follows() ​

ts
follows(limit?, options?): Promise<Paginator<Output>>

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

Enumerates accounts which a specified account (actor) follows.

Parameters ​

limit? ​

number

options? ​

RPCOptions = {}

Returns ​

Promise<Paginator<Output>>

lists() ​

ts
lists(limit?, options?): Promise<Paginator<Output>>

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

Enumerates the lists created by a specified account (actor).

Parameters ​

limit? ​

number

options? ​

RPCOptions = {}

Returns ​

Promise<Paginator<Output>>

relationships() ​

ts
relationships(others?, options?): Promise<{
  $type: string;
  actor: undefined | ActorLazyProfile;
  relationships: (
     | Typed<NotFoundActor, string>
     | Typed<Relationship, string>)[];
}>

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

Enumerates public relationships between one account, and a list of other accounts. Does not require auth.

Parameters ​

others? ​

string[]

options? ​

RPCOptions

Returns ​

Promise<{ $type: string; actor: undefined | ActorLazyProfile; relationships: ( | Typed<NotFoundActor, string> | Typed<Relationship, string>)[]; }>

starterPacks() ​

ts
starterPacks(limit?, options?): Promise<Paginator<Output>>

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

Get a list of starter packs created by the actor.

Parameters ​

limit? ​

number

options? ​

RPCOptions = {}

Returns ​

Promise<Paginator<Output>>

toJSON() ​

ts
toJSON(): object

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

Returns ​

object

did ​
ts
did: `did:${string}`;