0.5.2 • Published 1 month ago
user-api-client v0.5.2
user-api-client
Docs
This is a library that makes it easier for servers that are talking to the Tidepool User API.
Setup
require('user-api-client')(config, hostGetter, request);
config
-- an object containing configuration parametershostGetter
-- an object with a get() method. The get() method should return an array of objects that can be passed into url.format() to produce a valid url to talk to.httpClient
-- (optional) -- the result of require('./httpClient.js')(config). This is primarily exposed to allow for mocking in tests. If not supplied a new "correct" one will be created.members
-- client and middleware.
Client
login
login (username, password, cb)
Frontend to the API call to log in a userusername
-- stringpassword
-- passwordcb (err, response)
err
-- null if no error, else an error object *response
-- result from the /user/login api call
getAnonymousPair
getAnonymousPair (userid, cb)
Frontend to the API call to retrieve a pair from the user object without storing ituserid
-- Tidepool-assigned useridcb (err, response)
err
-- null if no error, else an error objectresponse
-- result from the /user/private api call
checkToken
checkToken (token, cb)
Frontend to the API call to check the validity of a server or user tokentoken
-- the server token to be checkedcb (err, response)
err
-- null if no error, else an objectresponse
-- result from the /user/token api call
createUser
createUser (userObj, cb)
Frontend to the API call to create a useruserObj
-- object containing username, emails and password fields at minimumcb (err, response)
err
-- null if no error, else an error objectresponse
-- result from the /user/user api call
withServerToken
withServerToken (cb)
Calls CB with a valid server token, iff one can be retrievedcb (err, token)
err
-- always null if callback is called at all *token
-- a valid server token
Middleware
expressify
expressify (middlewareFn)
Converts restify middleware into express middleware. *middlewareFn
-- the restify middleware Returns: middleware that works with express
checkToken
checkToken (client)
Middleware to process the session token -- expects a token in a request header, processes it, and returns information about the token in the _tokendata variable on the request. *client
-- client to use when talking to the user-api
0.5.2
1 month ago
0.5.1
1 month ago
0.5.1-alpha.6
2 months ago
0.5.1-alpha.5
2 months ago
0.5.1-alpha.4
4 months ago
0.5.1-alpha.3
5 months ago
0.5.1-alpha.1
7 months ago
0.5.1-alpha.2
6 months ago
0.5.0
5 years ago
0.4.4
5 years ago
0.4.3
5 years ago
0.4.2
5 years ago
0.4.1
5 years ago
0.5.0-use-secret.1
6 years ago
0.5.0-oauth.3
6 years ago
0.5.0-oauth.2
6 years ago
0.5.0-oauth.1
6 years ago
0.5.0-0auth.1
6 years ago
0.5.0-alpha.5
7 years ago
0.5.0-alpha.4
7 years ago
0.5.0-alpha.2
7 years ago
0.4.0
7 years ago
0.3.4
9 years ago
0.3.3
9 years ago
0.3.2
9 years ago
0.3.1
9 years ago
0.3.0
10 years ago
0.2.2
10 years ago
0.2.1
10 years ago
0.2.0
10 years ago
0.1.8
10 years ago
0.1.7
10 years ago
0.1.6
10 years ago
0.1.5
10 years ago
0.1.4
10 years ago
0.1.3
10 years ago
0.1.2
10 years ago
0.1.1
10 years ago
0.1.0
10 years ago
0.0.2
10 years ago
0.0.1
10 years ago