UNPKG

authmaker-verify/Readme.md

Version:

1.28 kBMarkdownView Raw

1[![Build Status](https://img.shields.io/travis/Authmaker/authmaker-verify/master.svg)](https://travis-ci.org/Authmaker/authmaker-verify)
2[![Code Climate](https://img.shields.io/codeclimate/github/Authmaker/authmaker-verify.svg)](https://codeclimate.com/github/Authmaker/authmaker-verify)
3
4[![Version npm](https://img.shields.io/npm/v/authmaker-verify.svg)](https://www.npmjs.com/package/authmaker-verify)
5[![Dependencies](https://img.shields.io/david/Authmaker/authmaker-verify.svg)](https://david-dm.org/Authmaker/authmaker-verify)
6[![npm Downloads](https://img.shields.io/npm/dm/authmaker-verify.svg)](https://www.npmjs.com/package/authmaker-verify)
7
8
9#### mongoRateLimited: function(access_token, tag, defaultScope)
10#### mongo: function(access_token, requiredScope)
11#### connectMongo: function(nconf)
12#### rateLimited: function()
13#### auditCount: function(access_token, tag, since)
14Use this function to get the count of a particular tag in the audit trail. If you pass the optional `since` parameter it will limit the count to number of audit trail entries since that time. Whatever is passed with the `since` parameter will be passed to `moment(since)` to build a date object directly so you can use any of the [valid parse objects for moment](http://momentjs.com/docs/#/parsing/)

1	`[![Build Status](https://img.shields.io/travis/Authmaker/authmaker-verify/master.svg)](https://travis-ci.org/Authmaker/authmaker-verify)`
2	`[![Code Climate](https://img.shields.io/codeclimate/github/Authmaker/authmaker-verify.svg)](https://codeclimate.com/github/Authmaker/authmaker-verify)`
3
4	`[![Version npm](https://img.shields.io/npm/v/authmaker-verify.svg)](https://www.npmjs.com/package/authmaker-verify)`
5	`[![Dependencies](https://img.shields.io/david/Authmaker/authmaker-verify.svg)](https://david-dm.org/Authmaker/authmaker-verify)`
6	`[![npm Downloads](https://img.shields.io/npm/dm/authmaker-verify.svg)](https://www.npmjs.com/package/authmaker-verify)`
7
8
9	`#### mongoRateLimited: function(access_token, tag, defaultScope)`
10	`#### mongo: function(access_token, requiredScope)`
11	`#### connectMongo: function(nconf)`
12	`#### rateLimited: function()`
13	`#### auditCount: function(access_token, tag, since)`
14	Use this function to get the count of a particular tag in the audit trail. If you pass the optional `since` parameter it will limit the count to number of audit trail entries since that time. Whatever is passed with the `since` parameter will be passed to `moment(since)` to build a date object directly so you can use any of the [valid parse objects for moment](http://momentjs.com/docs/#/parsing/)