hn-api-sdk/lib/hn-livedata.apiconf.d.ts

HackerNews API with TypeScript, generated by tsdk

import { APIConfig } from "./shared/tsdk-helper";
/**
 * Get the current largest item id. ({@link APIConfig})
 * @category Category
 */
export declare const GetMaxItemIdConfig: APIConfig;
/**
 *
 * @category live data
 */
export type GetMaxItemIdReq = object;
/**
 *
 * @category live data
 */
export type GetMaxItemIdRes = number;
/**
 * Up to 200-500 stories, query `new/top/best/ask/show/job` stories ({@link APIConfig})
 * @category live data
 */
export declare const GetStoriesConfig: APIConfig;
/**
 *
 * @category live data
 */
export type GetStoriesReq = {
    type: "new" | "top" | "best" | "ask" | "show" | "job";
};
/**
 *
 * @category live data
 */
export type GetStoriesRes = number[];
/**
 * Changed Items and Profiles ({@link APIConfig})
 * @category live data
 */
export declare const GetChangedItemsAndProfilesConfig: APIConfig;
/**
 *
 * @category live data
 */
export type GetChangedItemsAndProfilesReq = object;
/**
 *
 * @category live data
 */
export type GetChangedItemsAndProfilesRes = {
    /** items id */
    items: number[];
    /** profiles id */
    profiles: string[];
};