typicalcrimes
Version:
21 lines (20 loc) • 840 B
TypeScript
import { FBIMostWantedQueryParams, FBIMostWantedItemObject } from '../types';
declare class MissingPeople {
private _baseURL;
constructor(baseURL?: string);
/**
* Fetches and returns information accordingly to the item's unique uid
* @param { string } uid - Unique UID of the missing person's item object
*/
getItem(uid: string): Promise<FBIMostWantedItemObject>;
/** Fetches the list of FBI's most wanted if options is an object.
* If options is a string, it will assume it is a uid and fetches an item instead
* @param { FBIMostWantedQueryParams } params
* @return { Promise<object> }
*/
getItems({ page, ...rest }: FBIMostWantedQueryParams): Promise<{
total: number;
items: FBIMostWantedItemObject[];
}>;
}
export default MissingPeople;