Class CRSReportClient

Hierarchy (View Summary)

BaseClient
- CRSReportClient

Index

Constructors

constructor

new CRSReportClient(__namedParameters: { apiKey: string }): CRSReportClient
Parameters
- __namedParameters: { apiKey: string }
Returns CRSReportClient
Overrides BaseClient.constructor
- Defined in src/clients/crsreport.ts:6

Properties

`Protected` `Readonly`apiKey

apiKey: string

`Protected` `Readonly`baseUrl

baseUrl: string

`Protected` `Readonly`endpoint

endpoint: string

Methods

`Protected`get

get<T>(
endpoint: string,
params: Params,
): Promise<T & { rateLimit: RateLimitInfo }>
Type Parameters
- T
Parameters
- endpoint: string
- params: Params
Returns Promise<T & { rateLimit: RateLimitInfo }>
Inherited from BaseClient.get
- Defined in src/clients/base.ts:78

getReport

getReport(
    reportNumber: string,
    params?: { format?: Format },
): Promise<
    {
        CRSReport: {
            authors: { author: string }[];
            contentType: string;
            formats: { format: string; url: string }[];
            id: string;
            publishDate: string;
            relatedMaterials: {
                congress: number;
                number: string | number;
                title: null | string;
                type: string;
                URL: string;
            }[];
            status: string;
            summary: string;
            title: string;
            topics: { topic: string }[];
            updateDate: string;
            url: string;
            version: number;
        };
    } & { rateLimit: RateLimitInfo },
>
Returns detailed information for a specified Congressional Research Service (CRS) report.
Parameters
- reportNumber: string
  The report number to retrieve
- params: { format?: Format } = {}
  {BaseParams} - Format parameters
Returns Promise<
    {
        CRSReport: {
            authors: { author: string }[];
            contentType: string;
            formats: { format: string; url: string }[];
            id: string;
            publishDate: string;
            relatedMaterials: {
                congress: number;
                number: string | number;
                title: null | string;
                type: string;
                URL: string;
            }[];
            status: string;
            summary: string;
            title: string;
            topics: { topic: string }[];
            updateDate: string;
            url: string;
            version: number;
        };
    } & { rateLimit: RateLimitInfo },
>
Detailed information for the specified CRS report
- Defined in src/clients/crsreport.ts:25

getReports

getReports(
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        CRSReports: {
            contentType: string;
            id: string;
            publishDate: string;
            status: string;
            title: string;
            updateDate: string;
            url: string;
            version: number;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns Congressional Research Service (CRS) report data from the API.
Parameters
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Pagination and format parameters
Returns Promise<
    {
        CRSReports: {
            contentType: string;
            id: string;
            publishDate: string;
            status: string;
            title: string;
            updateDate: string;
            url: string;
            version: number;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of CRS reports
- Defined in src/clients/crsreport.ts:15

Class CRSReportClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CRSReportClient

Properties

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

Methods

`Protected`get

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getReport

Parameters

getReports

Parameters

Settings

On This Page

Class CRSReportClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CRSReportClient

Properties

Protected ReadonlyapiKey

Protected ReadonlybaseUrl

Protected Readonlyendpoint

Methods

Protectedget

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getReport

Parameters

getReports

Parameters

Returns Promise< { CRSReports: { contentType: string; id: string; publishDate: string; status: string; title: string; updateDate: string; url: string; version: number; }[]; } & { rateLimit: RateLimitInfo },>

Settings

On This Page

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

`Protected`get

Returns Promise<
{
CRSReports: {
contentType: string;
id: string;
publishDate: string;
status: string;
title: string;
updateDate: string;
url: string;
version: number;
}[];
} & { rateLimit: RateLimitInfo },
>