2.4.24 • Published 3 years ago
grav.client v2.4.24
Gravatar NodeJS SDK
A NodeJS SDK for the Gravatar XML-RPC API
If you are just getting started, be sure to see the Wiki and API docs.
Installation
$ npm install grav.client
Tests
# unit tests
$ npm run test
# end-to-end tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
# acceptance tests
$ npm run test:spec
Usage
import { GravatarClient } from 'grav.client';
const client = new GravatarClient('user@example.com', 'password');
client.test().then(data => ... );
Methods
Method | Description |
---|---|
client.exists() | check if a primary image is set |
client.addresses() | list account email addresses |
client.userImages() | list account images |
client.saveImage(imageFilePath) | upload an image |
client.saveEncodedImage(base64String) | upload an encoded image |
client.saveImageUrl(imageUrl) | upload image from URL |
client.useUserImage(imageName) | update primary image |
client.removeImage() | remove primary image |
client.deleteUserImage(imageName) | delete an image |
client.test() | sanity check |
Use Cases
grav.client
ships with several use case classes that model different programming scenarios:
FindImageUseCase
GetPrimaryImageUseCase
LoadNextImageUseCase
LoadPreviousImageUseCase
SetNewImageUseCase
VerifyAccountUseCase
Example:
import {
GravatarClient,
GetPrimaryImageUseCase
} from 'grav.client';
...
// create use case
const getPrimaryImageUseCase = new GetPrimaryImageUseCase();
// connect client
getPrimaryImageUseCase.client = new GravatarClient(email, password);
// let it rip
const primaryImage = await getPrimaryImageUseCase.execute();
License
2.4.24
3 years ago
2.4.23
3 years ago
2.4.22
3 years ago
2.4.21
3 years ago
2.4.20
3 years ago
2.4.19
3 years ago
2.4.18
4 years ago
2.4.17
4 years ago
2.4.16
4 years ago
2.4.15
4 years ago
2.4.14
4 years ago
2.3.14
4 years ago
2.3.13
4 years ago
2.3.12
4 years ago
2.2.12
4 years ago
2.2.11
4 years ago
2.2.9
4 years ago
2.2.10
4 years ago
2.2.8
4 years ago
2.2.6
4 years ago
2.2.5
4 years ago
2.2.1
4 years ago
2.2.0
4 years ago
2.2.3
4 years ago
2.2.2
4 years ago
2.2.4
4 years ago
2.1.9
5 years ago
2.1.8
5 years ago
2.1.7
5 years ago
2.1.6
5 years ago
2.1.5
5 years ago
2.1.4
5 years ago
2.1.3
5 years ago
2.1.2
5 years ago
2.1.1
5 years ago
1.1.1
5 years ago
1.0.1
5 years ago
0.0.1
5 years ago