{"id":27027014,"url":"https://github.com/tsdk-monorepo/hacker-news-api-sdk","last_synced_at":"2025-08-20T05:12:15.232Z","repository":{"id":212403440,"uuid":"730967944","full_name":"tsdk-monorepo/hacker-news-api-sdk","owner":"tsdk-monorepo","description":"The Browser and Node.js SDK of  Hacker News API","archived":false,"fork":false,"pushed_at":"2025-02-23T11:37:29.000Z","size":351,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-22T22:42:50.374Z","etag":null,"topics":["hacker-news-api","tsdk","typescript-library"],"latest_commit_sha":null,"homepage":"https://hn-api-sdk.tsdk.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tsdk-monorepo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-13T04:20:30.000Z","updated_at":"2025-02-23T11:36:34.000Z","dependencies_parsed_at":"2025-03-12T04:37:58.103Z","dependency_job_id":"94ad0b30-6114-4872-920f-aa00d283efd2","html_url":"https://github.com/tsdk-monorepo/hacker-news-api-sdk","commit_stats":null,"previous_names":["tsdk-monorepo/hacker-news-api-sdk"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsdk-monorepo%2Fhacker-news-api-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsdk-monorepo%2Fhacker-news-api-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsdk-monorepo%2Fhacker-news-api-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tsdk-monorepo%2Fhacker-news-api-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tsdk-monorepo","download_url":"https://codeload.github.com/tsdk-monorepo/hacker-news-api-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246852449,"owners_count":20844395,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacker-news-api","tsdk","typescript-library"],"created_at":"2025-04-04T23:16:48.695Z","updated_at":"2025-04-04T23:16:49.163Z","avatar_url":"https://github.com/tsdk-monorepo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hackernews API sdk\n\nUse [tsdk](https://tsdk.dev) to generate hacker news API sdk, based on the offical API documentation:\n\nhttps://github.com/HackerNews/API\n\n## Features\n\n- TypeScript types\n- Support SWR hooks\n\n## Documentation\n\nhttps://hn-api-sdk.tsdk.dev\n\n## Getting Started\n\nInstall:\n\n```sh\nnpm install hn-api-sdk\n```\n\nUsage (2 steps):\n\nStep 1, create `./user-api.ts` and `./user-api-hooks.ts`:\n\nCreate `user-api.ts` (use fetch)\n\n```ts\nimport xior, { XiorError } from \"xior\";\nimport { setHandler, setXiorInstance, xiorHandler } from \"hn-api-sdk\";\n\nexport * from \"hn-api-sdk/lib/user-api\";\nexport * from \"hn-api-sdk/lib/apiconf-refs\";\nexport * from \"hn-api-sdk/lib/shared-refs\";\n\nexport const baseURL = `https://hacker-news.firebaseio.com`;\n\nconst xiorInstance = xior.create({\n  baseURL,\n  headers: {},\n});\n\nxiorInstance.interceptors.request.use(\n  (config) =\u003e {\n    return config;\n  },\n  (error) =\u003e {\n    return Promise.reject(error);\n  }\n);\n\nxiorInstance.interceptors.response.use(\n  async (response) =\u003e {\n    return response;\n  },\n  async (error: XiorError) =\u003e {\n    return Promise.reject(error?.message);\n  }\n);\n\nsetXiorInstance(xiorInstance);\nsetHandler(xiorHandler);\n```\n\nOr use axios as the client, create `user-api.ts`:\n\n```ts\nimport axios, { AxiosError } from \"axios\";\nimport { setHandler, setAxiosInstance, axiosHandler } from \"hn-api-sdk\";\n\nexport * from \"hn-api-sdk/lib/user-api\";\nexport * from \"hn-api-sdk/lib/apiconf-refs\";\nexport * from \"hn-api-sdk/lib/shared-refs\";\n\nexport const baseURL = `https://hacker-news.firebaseio.com`;\n\nconst axiosInstance = axios.create({\n  baseURL,\n  headers: {},\n});\n\naxiosInstance.interceptors.request.use(\n  (config) =\u003e {\n    return config;\n  },\n  (error) =\u003e {\n    return Promise.reject(error);\n  }\n);\n\naxiosInstance.interceptors.response.use(\n  async (response) =\u003e {\n    return response;\n  },\n  async (error: AxiosError) =\u003e {\n    return Promise.reject(error?.message);\n  }\n);\n\nsetAxiosInstance(axiosInstance);\nsetHandler(axiosHandler);\n```\n\nCreate `user-api-hooks.ts`\n\n```ts user-api-hooks.ts\nimport \"./user-api\";\n\nexport * from \"hn-api-sdk/lib/user-api-hooks\";\n```\n\nStep 2, import module from `./user-api.ts`:\n\n```ts\nimport {\n  GetUserDetail,\n  GetStories,\n  GetStory,\n  GetComment,\n  GetAsk,\n  GetJob,\n  GetPoll,\n  GetPart,\n  GetMaxItemId,\n  GetChangedItemsAndProfiles,\n} from \"./user-api\";\n\nGetUserDetail({ id: \"jl\" }).then((res) =\u003e {\n  console.log(res.id, res.about, res.submitted);\n});\n```\n\n## Development\n\nFirst, install dependencies:\n\n\u003e Recommend use `pnpm`\n\n```sh\npnpm install\npnpm run ready\n```\n\nThen, sync `hn-api-sdk` packakge files:\n\n```sh\npnpm --filter=api sync-sdk\n```\n\nPublish to npm\n\n```sh\npnpm --filter=hn-api-sdk start-publish\n```\n\n### Npm package\n\nhttps://www.npmjs.com/package/hn-api-sdk\n\n### Thanks\n\n- https://transform.tools/json-to-typescript\n- https://github.com/HackerNews/API\n- https://tsdk.dev\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftsdk-monorepo%2Fhacker-news-api-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftsdk-monorepo%2Fhacker-news-api-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftsdk-monorepo%2Fhacker-news-api-sdk/lists"}