ashipov/immich
1
0
Fork 1
forked from dark_thunder/immich
Code Pull Requests Activity

chore: publish sdk on release (#7895)

Browse Source 
* chore: publish sdk on release

* fix: runtime dep

* chore: sync versions

* chore: update readme

* fix: use Node16 module resolution
This commit is contained in:
Jason Rasmussen
2024-03-12 12:01:12 -04:00
committed by GitHub
parent 779f5d9b3d
commit 17d7d9364f
11 changed files with 90 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
open-api/typescript-sdk/README.md Normal file
View File

@ -0,0 +1,28 @@
# @immich/sdk
A TypeScript SDK for interfacing with the [Immich](https://immich.app/) API.
## Install
```bash
npm i --save @immich/sdk
```
## Usage
For a more detailed example, check out the [`@immich/cli`](https://github.com/immich-app/immich/tree/main/cli).
```typescript
import { defaults, getAllAlbums, getAllAssets, getMyUserInfo } from "@immich/sdk";
const API_KEY = "<API_KEY>"; // process.env.IMMICH_API_KEY
defaults.baseUrl = "https://demo.immich.app/api";
defaults.headers = { "x-api-key": API_KEY };
const user = await getMyUserInfo();
const assets = await getAllAssets({ take: 1000 });
const albums = await getAllAlbums({});
console.log({ user, assets, albums });
```