mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-09 20:47:47 +00:00
Merge branch 'main' of https://github.com/LukeHagar/plexjs
This commit is contained in:
35
readme.md
35
readme.md
@@ -4,8 +4,41 @@
|
|||||||
|
|
||||||
A typescript sdk for accessing the Plex.tv and Plex Media Server REST API's.
|
A typescript sdk for accessing the Plex.tv and Plex Media Server REST API's.
|
||||||
|
|
||||||
|
Documentation for all of the available endpoints can be found here:
|
||||||
|
[https://plexapi.dev](https://plexapi.dev/docs/plex)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
npm
|
||||||
```bash
|
```bash
|
||||||
npm install plexjs
|
npm install @lukehagar/plexjs
|
||||||
|
```
|
||||||
|
|
||||||
|
yarn
|
||||||
|
```bash
|
||||||
|
yarn add @lukehagar/plexjs
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import {
|
||||||
|
Configuration,
|
||||||
|
ServerApi,
|
||||||
|
DevicesApi,
|
||||||
|
UserApi,
|
||||||
|
} from "@lukehagar/plexjs";
|
||||||
|
import dotenv from "dotenv";
|
||||||
|
dotenv.config();
|
||||||
|
|
||||||
|
const config = new Configuration({
|
||||||
|
basePath: process.env.BASE_PATH,
|
||||||
|
plexToken: process.env.PLEX_TOKEN,
|
||||||
|
});
|
||||||
|
|
||||||
|
new ServerApi(config).getServerCapabilities().then((resp) => console.log(resp));
|
||||||
|
|
||||||
|
new DevicesApi(config).getDevices().then((resp) => console.log(resp));
|
||||||
|
|
||||||
|
new UserApi(config).getUserDetails().then((resp) => console.log(resp));
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user