Readme.md 905 Bytes
Newer Older
Marius David Wieschollek's avatar
Marius David Wieschollek committed
1 2 3 4 5
This is as WIP! Expect changes.

This package contains a JavaScript client for the [Passwords app for Nextcloud](https://apps.nextcloud.com/apps/passwords)

You can find the API documentation [here](https://git.mdns.eu/nextcloud/passwords/wikis/developers/index)
6 7 8 9

### Using the client
You can use the enhanced version of the client in your project like this:
```javascript
10
import PasswordsClient from 'passwords-client';
11

12 13 14
let client = new PasswordsClient({baseUrl:'https://cloud.example.com/', user:'user', token:'12345-12345-12345-12345-12345'});
let passwordsRepository = client.getPasswordRepository();
let passwordCollection = await passwordsRepository.findAll();
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
```


### Development
You cah use a development version in your project with the following commands

```bash
# Go into library folder
cd passwords-client
sudo npm link

# Go into project folder
cd ../project
npm link passwords-client
```