This repository has been archived on 2021-04-12. You can view files and clone it, but cannot push or open issues or pull requests.
auth-client-helper/README.md

32 lines
587 B
Markdown
Raw Normal View History

2020-05-17 17:31:15 +02:00
# @sapphirecode/auth-client-helper
2020-03-06 08:29:01 +01:00
2020-05-17 17:32:26 +02:00
version: 1.0.x
2020-05-17 17:31:15 +02:00
client helper to authenticate on servers using the auth-server-helper
## Installation
npm:
> npm i --save @sapphirecode/auth-client-helper
yarn:
> yarn add @sapphirecode/auth-client-helper
2020-03-06 08:29:01 +01:00
## Usage
```js
const client = require('@scode/auth-client-helper');
// if using in the browser, will send a request to the current host
const session_id = client.login('user','passw');
// specify a host manually
const session_id = client.login('user','passw','https://example.com');
```
2020-05-17 17:31:15 +02:00
## License
MIT © Timo Hocker <timo@scode.ovh>