diff options
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/sdk/README.md | 4 | ||||
| -rw-r--r-- | packages/sdk/src/index.ts | 9 |
2 files changed, 10 insertions, 3 deletions
diff --git a/packages/sdk/README.md b/packages/sdk/README.md index 1bfc10ac..598b56e3 100644 --- a/packages/sdk/README.md +++ b/packages/sdk/README.md @@ -11,12 +11,12 @@ npm install @karakeep/sdk ## Usage ```typescript -import { createHoarderClient } from "@karakeep/sdk"; +import { createKarakeepClient } from "@karakeep/sdk"; // Create a client const apiKey = "my-super-secret-key"; const addr = `https://karakeep.mydomain.com`; -const client = createHoarderClient({ +const client = createKarakeepClient({ baseUrl: `${addr}/api/v1/`, headers: { "Content-Type": "application/json", diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts index 7b148cc6..7ff0c0dc 100644 --- a/packages/sdk/src/index.ts +++ b/packages/sdk/src/index.ts @@ -1,5 +1,12 @@ import createClient from "openapi-fetch"; -import type { paths } from "./hoarder-api.d.ts"; +import type { components, paths } from "./hoarder-api.d.ts"; +/** + * @deprecated Use createKarakeepClient instead. + */ export const createHoarderClient = createClient<paths>; + +export const createKarakeepClient = createClient<paths>; + +export type KarakeepAPISchemas = components["schemas"]; |