https://github.com/madkarmaa/streamable.js
NodeJS client to interact with the streamable.com API
https://github.com/madkarmaa/streamable.js
api-client node node-js nodejs-libraries nodejs-library npm npm-package streamable streamable-api
Last synced: 4 months ago
JSON representation
NodeJS client to interact with the streamable.com API
- Host: GitHub
- URL: https://github.com/madkarmaa/streamable.js
- Owner: madkarmaa
- Created: 2024-01-22T19:00:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-23T15:02:30.000Z (over 1 year ago)
- Last Synced: 2025-01-08T15:33:45.214Z (6 months ago)
- Topics: api-client, node, node-js, nodejs-libraries, nodejs-library, npm, npm-package, streamable, streamable-api
- Language: JavaScript
- Homepage:
- Size: 136 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
NodeJS client to interact with the Streamable API
> [!IMPORTANT]
>
> **Not compatible with browsers** because they restrict the access to the `Set-Cookie` request header, which is vital for the client to keep the user logged in, since it contains the session cookies.
> [!CAUTION]
>
> The use of this library is against the Streamable's **[Terms of Service](https://terms.streamable.com)**, specifically in [this line](https://terms.streamable.com/#:~:text=Use%20automated,Content), so use it at your own risk.
## ⚙️ Installation
```
npm install @madkarma/streamable-js
```
## ❓ How to
Once the package is installed, you can import the library:
```js
const StreamableClient = require('@madkarma/streamable-js');
```
### Basic usage
```js
const StreamableClient = require('@madkarma/streamable-js');
// Create an instance of the Streamable client
const client = new StreamableClient();
// Start a new client session using your account credentials
client.login('[email protected]', 'examplePassword').then(async () => {
// You're now logged in! Let's try it out!
const { email } = await client.getUserData();
console.log(email); // Example output: '[email protected]'
// Your code here...
});
```
## [📖 Docs](https://github.com/madkarmaa/streamable.js/blob/main/docs/DOCS.md)