Class AbgeordnetenwatchClient

Index

Constructors

Methods

Constructors

constructor

new AbgeordnetenwatchClient(options?: EngineOptions): AbgeordnetenwatchClient
Parameters
- options: EngineOptions = {}
Returns AbgeordnetenwatchClient
- Defined in src/client/client.ts:27

Methods

count

count(
    collection:
        | "parliaments"
        | "parliament-periods"
        | "politicians"
        | "candidacies-mandates"
        | "committees"
        | "committee-memberships"
        | "polls"
        | "votes"
        | "parties"
        | "fractions"
        | "election-program"
        | "electoral-lists"
        | "constituencies"
        | "sidejobs"
        | "sidejob-organizations"
        | "topics"
        | "cities"
        | "countries",
    params?: ListParams,
): Promise<number>
How many entities match the given filters.

Asks for a single item (range_end: 1) and reads meta.result.total, which the API reports as the true match count independent of the page size.
Parameters
- collection:
      | "parliaments"
      | "parliament-periods"
      | "politicians"
      | "candidacies-mandates"
      | "committees"
      | "committee-memberships"
      | "polls"
      | "votes"
      | "parties"
      | "fractions"
      | "election-program"
      | "electoral-lists"
      | "constituencies"
      | "sidejobs"
      | "sidejob-organizations"
      | "topics"
      | "cities"
      | "countries"
- params: ListParams = {}
Returns Promise<number>
- Defined in src/client/client.ts:66

get

get<T = JsonObject>(
    collection:
        | "parliaments"
        | "parliament-periods"
        | "politicians"
        | "candidacies-mandates"
        | "committees"
        | "committee-memberships"
        | "polls"
        | "votes"
        | "parties"
        | "fractions"
        | "election-program"
        | "electoral-lists"
        | "constituencies"
        | "sidejobs"
        | "sidejob-organizations"
        | "topics"
        | "cities"
        | "countries",
    id: string | number,
): Promise<DetailResponse<T>>
Fetch a single entity by id; returns the full envelope (meta + data object).
Type Parameters
- T = JsonObject
Parameters
- collection:
      | "parliaments"
      | "parliament-periods"
      | "politicians"
      | "candidacies-mandates"
      | "committees"
      | "committee-memberships"
      | "polls"
      | "votes"
      | "parties"
      | "fractions"
      | "election-program"
      | "electoral-lists"
      | "constituencies"
      | "sidejobs"
      | "sidejob-organizations"
      | "topics"
      | "cities"
      | "countries"
- id: string | number
Returns Promise<DetailResponse<T>>
- Defined in src/client/client.ts:53

list

list<T = JsonObject>(
    collection:
        | "parliaments"
        | "parliament-periods"
        | "politicians"
        | "candidacies-mandates"
        | "committees"
        | "committee-memberships"
        | "polls"
        | "votes"
        | "parties"
        | "fractions"
        | "election-program"
        | "electoral-lists"
        | "constituencies"
        | "sidejobs"
        | "sidejob-organizations"
        | "topics"
        | "cities"
        | "countries",
    params?: ListParams,
): Promise<ListResponse<T>>
List a collection; returns the full envelope (meta + data array).
Type Parameters
- T = JsonObject
Parameters
- collection:
      | "parliaments"
      | "parliament-periods"
      | "politicians"
      | "candidacies-mandates"
      | "committees"
      | "committee-memberships"
      | "polls"
      | "votes"
      | "parties"
      | "fractions"
      | "election-program"
      | "electoral-lists"
      | "constituencies"
      | "sidejobs"
      | "sidejob-organizations"
      | "topics"
      | "cities"
      | "countries"
- params: ListParams = {}
Returns Promise<ListResponse<T>>
- Defined in src/client/client.ts:45