hn-api-sdk
Version:
HackerNews API with TypeScript, generated by tsdk
235 lines (234 loc) • 8.48 kB
TypeScript
/**
*
* api-user.ts
* hn-api-sdk@1.0.0
*
**/
/**
* Get ask detail
*
* @category items
*/
export declare const GetAsk: {
(data: {
id: number;
}, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: {
id: number;
} | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<{
by: string;
id: number;
kids: number[];
text: string;
time: number;
type: "job" | "story" | "comment" | "poll" | "pollopt";
descendants: number;
score: number;
title: string;
}>;
config: import("./shared-refs").APIConfig;
};
/**
* Changed Items and Profiles
*
* @category live data
*/
export declare const GetChangedItemsAndProfiles: {
(data: object, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: object | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<{
items: number[];
profiles: string[];
}>;
config: import("./shared-refs").APIConfig;
};
/**
* Get commend detail
*
* @category items
*/
export declare const GetComment: {
(data: {
id: number;
}, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: {
id: number;
} | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<{
by: string;
id: number;
kids: number[];
parent: number;
text: string;
time: number;
type: "job" | "story" | "comment" | "poll" | "pollopt";
}>;
config: import("./shared-refs").APIConfig;
};
/**
* Get job detail
*
* @category items
*/
export declare const GetJob: {
(data: {
id: number;
}, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: {
id: number;
} | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<{
by: string;
id: number;
text: string;
time: number;
url: string;
type: "job" | "story" | "comment" | "poll" | "pollopt";
score: number;
title: string;
}>;
config: import("./shared-refs").APIConfig;
};
/**
* Get the current largest item id.
*
* @category live data
*/
export declare const GetMaxItemId: {
(data: object, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: object | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<number>;
config: import("./shared-refs").APIConfig;
};
/**
* Get part detail
*
* @category items
*/
export declare const GetPart: {
(data: {
id: number;
}, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: {
id: number;
} | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<{
poll: number;
type: "job" | "story" | "comment" | "poll" | "pollopt";
score: number;
by: string;
id: number;
text: string;
time: number;
}>;
config: import("./shared-refs").APIConfig;
};
/**
* Get poll detail
*
* @category items
*/
export declare const GetPoll: {
(data: {
id: number;
}, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: {
id: number;
} | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<{
descendants: number;
kids: number[];
parts: number[];
title: string;
type: "job" | "story" | "comment" | "poll" | "pollopt";
score: number;
by: string;
id: number;
text: string;
time: number;
}>;
config: import("./shared-refs").APIConfig;
};
/**
* Up to 200-500 stories, query `new/top/best/ask/show/job` stories
*
* @category live data
*/
export declare const GetStories: {
(data: {
type: "new" | "top" | "best" | "ask" | "show" | "job";
}, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: {
type: "new" | "top" | "best" | "ask" | "show" | "job";
} | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<number[]>;
config: import("./shared-refs").APIConfig;
};
/**
* Get story detail
*
* @category items
*/
export declare const GetStory: {
(data: {
id: number;
}, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: {
id: number;
} | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<{
by: string;
id: number;
descendants: number;
kids: number[];
score: number;
title: string;
time: number;
type: "job" | "story" | "comment" | "poll" | "pollopt";
url: string;
}>;
config: import("./shared-refs").APIConfig;
};
/**
* Query user detail
*
* @category users
*/
export declare const GetUserDetail: {
(data: {
id: string;
}, requestConfig?: import("./shared-refs").ObjectLiteral | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: {
id: string;
} | undefined;
}) | undefined, customHandler?: (apiConfig: import("./shared-refs").APIConfig, requestData: any, requestConfig?: any | (Omit<import("xior").XiorRequestConfig<any>, "data"> & {
data?: any;
}) | import("./shared-refs").ObjectLiteral | import("./xior").XiorRequestConfig<any>) => Promise<any>): Promise<{
id: string;
created: number;
karma: number;
about?: string | undefined;
delay: number;
submitted: number[];
}>;
config: import("./shared-refs").APIConfig;
};