hn-api-sdk - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

lib/hn-livedata.apiconf.d.ts

@@ -18,3 +18,3 @@ import { APIConfig } from "./shared/tsdk-helper";
 /**
- * Up to 200-500 stories, include `new/top/best/ask/show/job` stories ({@link APIConfig})
+ * Up to 200-500 stories, query `new/top/best/ask/show/job` stories ({@link APIConfig})
  * @category live data
@@ -21,0 +21,0 @@ */

lib/hn-livedata.apiconf.js

@@ -17,3 +17,3 @@ "use strict";
 /**
- * Up to 200-500 stories, include `new/top/best/ask/show/job` stories ({@link APIConfig})
+ * Up to 200-500 stories, query `new/top/best/ask/show/job` stories ({@link APIConfig})
  * @category live data
@@ -25,3 +25,3 @@ */
     path: "/v0/{type}stories.json",
-    description: "Up to 200-500 stories, include `new/top/best/ask/show/job` stories",
+    description: "Up to 200-500 stories, query `new/top/best/ask/show/job` stories",
     category: "live data",
@@ -28,0 +28,0 @@ paramsInUrl: '{}'

lib/permissions.json

@@ -68,3 +68,3 @@ {
       "path": "/v0/{type}stories.json",
-      "description": "Up to 200-500 stories, include `new/top/best/ask/show/job` stories",
+      "description": "Up to 200-500 stories, query `new/top/best/ask/show/job` stories",
       "category": "live data",
@@ -71,0 +71,0 @@ "paramsInUrl": "{}",

lib/user-api-hooks.d.ts

@@ -9,3 +9,3 @@ import { SWRConfiguration } from "swr";
  */
-export declare function useGetAsk(payload: GetAskReq, options?: SWRConfiguration<GetAskRes>, requestConfig?: AxiosRequestConfig<GetAskReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetAskRes, any, Partial<import("swr/_internal").PublicConfiguration<GetAskRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetAsk(payload: GetAskReq | undefined, options?: SWRConfiguration<GetAskRes | undefined>, requestConfig?: AxiosRequestConfig<GetAskReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetAskRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetAskRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
@@ -16,3 +16,3 @@ * Changed Items and Profiles
  */
-export declare function useGetChangedItemsAndProfiles(payload: GetChangedItemsAndProfilesReq, options?: SWRConfiguration<GetChangedItemsAndProfilesRes>, requestConfig?: AxiosRequestConfig<GetChangedItemsAndProfilesReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetChangedItemsAndProfilesRes, any, Partial<import("swr/_internal").PublicConfiguration<GetChangedItemsAndProfilesRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetChangedItemsAndProfiles(payload: GetChangedItemsAndProfilesReq | undefined, options?: SWRConfiguration<GetChangedItemsAndProfilesRes | undefined>, requestConfig?: AxiosRequestConfig<GetChangedItemsAndProfilesReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetChangedItemsAndProfilesRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetChangedItemsAndProfilesRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
@@ -23,3 +23,3 @@ * Get commend detail
  */
-export declare function useGetComment(payload: GetCommentReq, options?: SWRConfiguration<GetCommentRes>, requestConfig?: AxiosRequestConfig<GetCommentReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetCommentRes, any, Partial<import("swr/_internal").PublicConfiguration<GetCommentRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetComment(payload: GetCommentReq | undefined, options?: SWRConfiguration<GetCommentRes | undefined>, requestConfig?: AxiosRequestConfig<GetCommentReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetCommentRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetCommentRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
@@ -30,3 +30,3 @@ * Get job detail
  */
-export declare function useGetJob(payload: GetJobReq, options?: SWRConfiguration<GetJobRes>, requestConfig?: AxiosRequestConfig<GetJobReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetJobRes, any, Partial<import("swr/_internal").PublicConfiguration<GetJobRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetJob(payload: GetJobReq | undefined, options?: SWRConfiguration<GetJobRes | undefined>, requestConfig?: AxiosRequestConfig<GetJobReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetJobRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetJobRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
@@ -37,3 +37,3 @@ * Get the current largest item id.
  */
-export declare function useGetMaxItemId(payload: GetMaxItemIdReq, options?: SWRConfiguration<GetMaxItemIdRes>, requestConfig?: AxiosRequestConfig<GetMaxItemIdReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<number, any, Partial<import("swr/_internal").PublicConfiguration<number, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetMaxItemId(payload: GetMaxItemIdReq | undefined, options?: SWRConfiguration<GetMaxItemIdRes | undefined>, requestConfig?: AxiosRequestConfig<GetMaxItemIdReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<number | undefined, any, Partial<import("swr/_internal").PublicConfiguration<number | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
@@ -44,3 +44,3 @@ * Get part detail
  */
-export declare function useGetPart(payload: GetPartReq, options?: SWRConfiguration<GetPartRes>, requestConfig?: AxiosRequestConfig<GetPartReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetPartRes, any, Partial<import("swr/_internal").PublicConfiguration<GetPartRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetPart(payload: GetPartReq | undefined, options?: SWRConfiguration<GetPartRes | undefined>, requestConfig?: AxiosRequestConfig<GetPartReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetPartRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetPartRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
@@ -51,9 +51,9 @@ * Get poll detail
  */
-export declare function useGetPoll(payload: GetPollReq, options?: SWRConfiguration<GetPollRes>, requestConfig?: AxiosRequestConfig<GetPollReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetPollRes, any, Partial<import("swr/_internal").PublicConfiguration<GetPollRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetPoll(payload: GetPollReq | undefined, options?: SWRConfiguration<GetPollRes | undefined>, requestConfig?: AxiosRequestConfig<GetPollReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetPollRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetPollRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
- * Up to 200-500 stories, include `new/top/best/ask/show/job` stories
+ * Up to 200-500 stories, query `new/top/best/ask/show/job` stories
  *
  * @category live data
  */
-export declare function useGetStories(payload: GetStoriesReq, options?: SWRConfiguration<GetStoriesRes>, requestConfig?: AxiosRequestConfig<GetStoriesReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetStoriesRes, any, Partial<import("swr/_internal").PublicConfiguration<GetStoriesRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetStories(payload: GetStoriesReq | undefined, options?: SWRConfiguration<GetStoriesRes | undefined>, requestConfig?: AxiosRequestConfig<GetStoriesReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetStoriesRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetStoriesRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
@@ -64,3 +64,3 @@ * Get story detail
  */
-export declare function useGetStory(payload: GetStoryReq, options?: SWRConfiguration<GetStoryRes>, requestConfig?: AxiosRequestConfig<GetStoryReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetStoryRes, any, Partial<import("swr/_internal").PublicConfiguration<GetStoryRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetStory(payload: GetStoryReq | undefined, options?: SWRConfiguration<GetStoryRes | undefined>, requestConfig?: AxiosRequestConfig<GetStoryReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetStoryRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetStoryRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
 /**
@@ -71,2 +71,2 @@ * Query user detail
  */
-export declare function useGetUserDetail(payload: GetUserDetailReq, options?: SWRConfiguration<GetUserDetailRes>, requestConfig?: AxiosRequestConfig<GetUserDetailReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetUserDetailRes, any, Partial<import("swr/_internal").PublicConfiguration<GetUserDetailRes, any, import("swr/_internal").BareFetcher<any>>> | undefined>;
+export declare function useGetUserDetail(payload: GetUserDetailReq | undefined, options?: SWRConfiguration<GetUserDetailRes | undefined>, requestConfig?: AxiosRequestConfig<GetUserDetailReq>, needTrim?: boolean): import("swr/_internal").SWRResponse<GetUserDetailRes | undefined, any, Partial<import("swr/_internal").PublicConfiguration<GetUserDetailRes | undefined, any, import("swr/_internal").BareFetcher<any>>> | undefined>;

lib/user-api-hooks.js

@@ -15,4 +15,6 @@ "use strict";
 function useGetAsk(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetAsk.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetAsk.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetAsk)(arg, requestConfig, needTrim);
@@ -28,4 +30,6 @@ }, options);
 function useGetChangedItemsAndProfiles(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetChangedItemsAndProfiles.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetChangedItemsAndProfiles.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetChangedItemsAndProfiles)(arg, requestConfig, needTrim);
@@ -41,4 +45,6 @@ }, options);
 function useGetComment(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetComment.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetComment.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetComment)(arg, requestConfig, needTrim);
@@ -54,4 +60,6 @@ }, options);
 function useGetJob(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetJob.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetJob.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetJob)(arg, requestConfig, needTrim);
@@ -67,4 +75,6 @@ }, options);
 function useGetMaxItemId(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetMaxItemId.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetMaxItemId.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetMaxItemId)(arg, requestConfig, needTrim);
@@ -80,4 +90,6 @@ }, options);
 function useGetPart(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetPart.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetPart.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetPart)(arg, requestConfig, needTrim);
@@ -93,4 +105,6 @@ }, options);
 function useGetPoll(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetPoll.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetPoll.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetPoll)(arg, requestConfig, needTrim);
@@ -101,3 +115,3 @@ }, options);
 /**
- * Up to 200-500 stories, include `new/top/best/ask/show/job` stories
+ * Up to 200-500 stories, query `new/top/best/ask/show/job` stories
  *
@@ -107,4 +121,6 @@ * @category live data
 function useGetStories(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetStories.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetStories.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetStories)(arg, requestConfig, needTrim);
@@ -120,4 +136,6 @@ }, options);
 function useGetStory(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetStory.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetStory.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetStory)(arg, requestConfig, needTrim);
@@ -133,4 +151,6 @@ }, options);
 function useGetUserDetail(payload, options, requestConfig, needTrim) {
-    return (0, swr_1.default)({ url: user_api_1.GetUserDetail.config.path, arg: payload }, function (_a) {
+    return (0, swr_1.default)(function () { return ({ url: user_api_1.GetUserDetail.config.path, arg: payload }); }, function (_a) {
         var arg = _a.arg;
+        if (typeof arg === 'undefined')
+            return undefined;
         return (0, user_api_1.GetUserDetail)(arg, requestConfig, needTrim);
@@ -137,0 +157,0 @@ }, options);

lib/user-api.d.ts

@@ -72,3 +72,3 @@ /**
 /**
- * Up to 200-500 stories, include `new/top/best/ask/show/job` stories
+ * Up to 200-500 stories, query `new/top/best/ask/show/job` stories
  *
@@ -75,0 +75,0 @@ * @category live data

lib/user-api.js

@@ -58,3 +58,3 @@ "use strict";
 /**
- * Up to 200-500 stories, include `new/top/best/ask/show/job` stories
+ * Up to 200-500 stories, query `new/top/best/ask/show/job` stories
  *
@@ -61,0 +61,0 @@ * @category live data

package.json

 {
   "name": "hn-api-sdk",
   "description": "HackerNews API with TypeScript, generated by tsdk",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "main": "lib/index.js",
@@ -6,0 +6,0 @@ "keywords": [

README.md

@@ -12,5 +12,5 @@ # Hackernews API sdk
 
-## Documentation
+## Source code
 
-https://hn-api-sdk.tsdk.dev
+https://github.com/tsdk-monorepo/hacker-news-api-sdk
 
@@ -17,0 +17,0 @@ ## Getting Started

No alert changes

Improved metrics

Total package byte prevSize

60009

increased by2.47%

Lines of code

1691

increased by1.2%

No dependency changes