Class API

Hierarchy

API
- Stream

Index

Constructors

constructor

new API(options): API
Parameters
- options: APIOptions
Returns API
- Defined in src/api/index.ts:11

Properties

`Private` #agents

#agents: Map<string, BskyAgent> = ...

`Private` #debug

#debug: boolean = false

`Protected` options

options: APIOptions

Accessors

agents

get agents(): {
    add: ((keys) => Promise<void>);
    list: (() => BskyAgent[]);
    remove: ((name, service?) => API);
    search: ((query, searchType?) => null | BskyAgent[]);
}
Returns {
    add: ((keys) => Promise<void>);
    list: (() => BskyAgent[]);
    remove: ((name, service?) => API);
    search: ((query, searchType?) => null | BskyAgent[]);
}
- add: ((keys) => Promise<void>)
  - - (keys): Promise<void>
    - Parameters
      
      keys: APIKey | APIKey[]
      Returns Promise<void>
- list: (() => BskyAgent[])
  - - (): BskyAgent[]
    - Returns BskyAgent[]
- remove: ((name, service?) => API)
  - - (name, service?): API
    - Parameters
      
      name: string
      
      Optional service: string
      Returns API
- search: ((query, searchType?) => null | BskyAgent[])
  - - (query, searchType?): null | BskyAgent[]
    - Parameters
      
      query: {
      service?: string;
      username?: string;
      }
      
      Optional service?: string
      
      Optional username?: string
      
      searchType: "filter" | "find" = "find"
      Returns null | BskyAgent[]
- Defined in src/api/index.ts:24

users

get users(): {
    feeds: {
        fetch: ((name, options?) => Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>);
        fetchMultiple: ((names, options?) => Promise<{
            message: string;
            status: false;
        } | {
            data: Map<string, FeedViewPost[]>;
            status: true;
        }>);
    };
    fetch: ((name) => Promise<{
        message: string;
        status: false;
    } | {
        data: ProfileViewDetailed;
        status: true;
    }>);
    fetchMultiple: ((names) => Promise<{
        message: string;
        status: false;
    } | {
        data: ProfileViewDetailed[];
        status: true;
    }>);
    likes: {
        get: ((name, limit?) => Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>);
    };
}
Returns {
    feeds: {
        fetch: ((name, options?) => Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>);
        fetchMultiple: ((names, options?) => Promise<{
            message: string;
            status: false;
        } | {
            data: Map<string, FeedViewPost[]>;
            status: true;
        }>);
    };
    fetch: ((name) => Promise<{
        message: string;
        status: false;
    } | {
        data: ProfileViewDetailed;
        status: true;
    }>);
    fetchMultiple: ((names) => Promise<{
        message: string;
        status: false;
    } | {
        data: ProfileViewDetailed[];
        status: true;
    }>);
    likes: {
        get: ((name, limit?) => Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>);
    };
}
- feeds: {
      fetch: ((name, options?) => Promise<{
          message: string;
          status: false;
      } | {
          data: FeedViewPost[];
          status: true;
      }>);
      fetchMultiple: ((names, options?) => Promise<{
          message: string;
          status: false;
      } | {
          data: Map<string, FeedViewPost[]>;
          status: true;
      }>);
  }
  - fetch: ((name, options?) => Promise<{
        message: string;
        status: false;
    } | {
        data: FeedViewPost[];
        status: true;
    }>)
    - - (name, options?): Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>
      - Parameters
        
        name: string
        
        Optional options: FeedOptions
        
        Returns Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>
  - fetchMultiple: ((names, options?) => Promise<{
        message: string;
        status: false;
    } | {
        data: Map<string, FeedViewPost[]>;
        status: true;
    }>)
    - - (names, options?): Promise<{
            message: string;
            status: false;
        } | {
            data: Map<string, FeedViewPost[]>;
            status: true;
        }>
      - Parameters
        
        names: string[]
        
        Optional options: FeedOptions
        
        Returns Promise<{
            message: string;
            status: false;
        } | {
            data: Map<string, FeedViewPost[]>;
            status: true;
        }>
- fetch: ((name) => Promise<{
      message: string;
      status: false;
  } | {
      data: ProfileViewDetailed;
      status: true;
  }>)
  - - (name): Promise<{
          message: string;
          status: false;
      } | {
          data: ProfileViewDetailed;
          status: true;
      }>
    - Parameters
      
      name: string
      Returns Promise<{
          message: string;
          status: false;
      } | {
          data: ProfileViewDetailed;
          status: true;
      }>
- fetchMultiple: ((names) => Promise<{
      message: string;
      status: false;
  } | {
      data: ProfileViewDetailed[];
      status: true;
  }>)
  - - (names): Promise<{
          message: string;
          status: false;
      } | {
          data: ProfileViewDetailed[];
          status: true;
      }>
    - Parameters
      
      names: string[]
      Returns Promise<{
          message: string;
          status: false;
      } | {
          data: ProfileViewDetailed[];
          status: true;
      }>
- likes: {
      get: ((name, limit?) => Promise<{
          message: string;
          status: false;
      } | {
          data: FeedViewPost[];
          status: true;
      }>);
  }
  - get: ((name, limit?) => Promise<{
        message: string;
        status: false;
    } | {
        data: FeedViewPost[];
        status: true;
    }>)
    - - (name, limit?): Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>
      - Parameters
        
        name: string
        
        limit: number = 100
        
        Returns Promise<{
            message: string;
            status: false;
        } | {
            data: FeedViewPost[];
            status: true;
        }>
- Defined in src/api/index.ts:85

Methods

`Private` #getDefaultService

#getDefaultService(): string
Returns string
- Defined in src/api/index.ts:59

`Private` #getStr

#getStr(username, service?): string
Parameters
- username: string
- Optional service: string
Returns string
- Defined in src/api/index.ts:63

`Private` agent

agent(key?): Promise<BskyAgent>
Parameters
- Optional key: APIKey
Returns Promise<BskyAgent>
- Defined in src/api/index.ts:67

`Private` debug

debug(...args): void
Parameters
- Rest ...args: unknown[]
Returns void
- Defined in src/api/index.ts:17

Class API

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: APIOptions

Returns API

Properties

Private #agents

Private #debug

Protected options

Accessors

agents

Returns { add: ((keys) => Promise<void>); list: (() => BskyAgent[]); remove: ((name, service?) => API); search: ((query, searchType?) => null | BskyAgent[]); }

add: ((keys) => Promise<void>)

Parameters

keys: APIKey | APIKey[]

Returns Promise<void>

list: (() => BskyAgent[])

Returns BskyAgent[]

remove: ((name, service?) => API)

Parameters

name: string

Optional service: string

Returns API

search: ((query, searchType?) => null | BskyAgent[])

Parameters

query: { service?: string; username?: string; }

Optional service?: string

Optional username?: string

searchType: "filter" | "find" = "find"

Returns null | BskyAgent[]

users

feeds: { fetch: ((name, options?) => Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>); fetchMultiple: ((names, options?) => Promise<{ message: string; status: false; } | { data: Map<string, FeedViewPost[]>; status: true; }>); }

fetch: ((name, options?) => Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>)

Parameters

name: string

Optional options: FeedOptions

Returns Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>

fetchMultiple: ((names, options?) => Promise<{ message: string; status: false; } | { data: Map<string, FeedViewPost[]>; status: true; }>)

Parameters

names: string[]

Optional options: FeedOptions

Returns Promise<{ message: string; status: false; } | { data: Map<string, FeedViewPost[]>; status: true; }>

fetch: ((name) => Promise<{ message: string; status: false; } | { data: ProfileViewDetailed; status: true; }>)

Parameters

name: string

Returns Promise<{ message: string; status: false; } | { data: ProfileViewDetailed; status: true; }>

fetchMultiple: ((names) => Promise<{ message: string; status: false; } | { data: ProfileViewDetailed[]; status: true; }>)

Parameters

names: string[]

Returns Promise<{ message: string; status: false; } | { data: ProfileViewDetailed[]; status: true; }>

likes: { get: ((name, limit?) => Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>); }

get: ((name, limit?) => Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>)

Parameters

name: string

limit: number = 100

Returns Promise<{ message: string; status: false; } | { data: FeedViewPost[]; status: true; }>

Methods

Private #getDefaultService

Returns string

Private #getStr

Parameters

username: string

Optional service: string

Returns string

Private agent

Parameters

Optional key: APIKey

Returns Promise<BskyAgent>

Private debug

Parameters

Rest ...args: unknown[]

Returns void

Settings

`Private` #agents

`Private` #debug

`Protected` options

Returns {
add: ((keys) => Promise<void>);
list: (() => BskyAgent[]);
remove: ((name, service?) => API);
search: ((query, searchType?) => null | BskyAgent[]);
}

`Optional` service: string

query: {
service?: string;
username?: string;
}

`Optional` service?: string

`Optional` username?: string

feeds: {
fetch: ((name, options?) => Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>);
fetchMultiple: ((names, options?) => Promise<{
message: string;
status: false;
} | {
data: Map<string, FeedViewPost[]>;
status: true;
}>);
}

fetch: ((name, options?) => Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>)

`Optional` options: FeedOptions

Returns Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>

fetchMultiple: ((names, options?) => Promise<{
message: string;
status: false;
} | {
data: Map<string, FeedViewPost[]>;
status: true;
}>)

`Optional` options: FeedOptions

Returns Promise<{
message: string;
status: false;
} | {
data: Map<string, FeedViewPost[]>;
status: true;
}>

fetch: ((name) => Promise<{
message: string;
status: false;
} | {
data: ProfileViewDetailed;
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
data: ProfileViewDetailed;
status: true;
}>

fetchMultiple: ((names) => Promise<{
message: string;
status: false;
} | {
data: ProfileViewDetailed[];
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
data: ProfileViewDetailed[];
status: true;
}>

likes: {
get: ((name, limit?) => Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>);
}

get: ((name, limit?) => Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
data: FeedViewPost[];
status: true;
}>

`Private` #getDefaultService

`Private` #getStr

`Optional` service: string

`Private` agent

`Optional` key: APIKey

`Private` debug

`Rest` ...args: unknown[]