github-repos:查询用户有权访问的所有顶级存储库数据的 Github

  • D8_177841
    了解作者
  • 13KB
    文件大小
  • zip
    文件格式
  • 0
    收藏次数
  • VIP专享
    资源类型
  • 0
    下载次数
  • 2022-06-15 02:57
    上传日期
Github 存储库 查询用户有权访问的所有顶级存储库数据的 。 安装 $ npm install @kgryte/github-repos 要在浏览器中使用,请使用 。 用法 var getRepos = require ( '@kgryte/github-repos' ) ; getRepos( token[, opts]) 创建一个新的实例,用于在中查询用户有权访问的所有顶级存储库数据。 var token = 'tkjorjk34ek3nj4!' ; var query = getRepos ( token ) ; query . on ( 'data' , onData ) ; function onData ( evt ) { console . log ( evt . data ) ; // returns [{...},{...},...] } 该func
github-repos-master.zip
  • github-repos-master
  • .travis.yml
    146B
  • bin
  • usage.txt
    277B
  • opts.json
    150B
  • cli
    3.1KB
  • .jshintignore
    118B
  • package.json
    1.7KB
  • test
  • test.js
    2.9KB
  • LICENSE
    1.1KB
  • TODO.md
    141B
  • .npmignore
    498B
  • examples
  • index.js
    1.5KB
  • .gitignore
    711B
  • lib
  • index.js
    1.6KB
  • opts.json
    258B
  • Makefile
    1.7KB
  • README.md
    6.3KB
  • .jshintrc
    1.2KB
  • .editorconfig
    169B
  • .gitattributes
    12B
内容介绍
Github Repos === [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url] > Queries [Github](https://developer.github.com/v3/) for all top-level repository data to which a user has access. ## Installation ``` bash $ npm install @kgryte/github-repos ``` For use in the browser, use [browserify](https://github.com/substack/node-browserify). ## Usage ``` javascript var getRepos = require( '@kgryte/github-repos' ); ``` #### getRepos( token[, opts]) Creates a new [`Query`](https://github.com/kgryte/github-get) instance for querying [Github](https://developer.github.com/v3/) for all top-level repository data to which a user has access. ``` javascript var token = 'tkjorjk34ek3nj4!'; var query = getRepos( token ); query.on( 'data', onData ); function onData( evt ) { console.log( evt.data ); // returns [{...},{...},...] } ``` The `function` accepts the following `options`: - __interval__: positive `number` defining a poll [interval](https://developer.mozilla.org/en-US/docs/Web/API/WindowTimers/setInterval) for repeatedly querying the Github API. The interval should be in units of `milliseconds`. If an `interval` is __not__ provided, only a single query is made to the Github API. ``` javascript var query, token, opts; token = 'tkjorjk34ek3nj4!'; opts = { 'interval': 600000 // 10 minutes }; // Every 10 minutes, fetch the list of repos... query = getRepos( token, opts ); query.on( 'data', onData ); function onData( evt ) { console.log( evt.data ); // returns [{...},{...},...] } ``` ## Notes - This `function` is a light wrapper around [github-get](https://github.com/kgryte/github-get). The returned `Query` instance has the exact same API, meaning that all `Query` attributes, methods, and events are available. See [github-get](https://github.com/kgryte/github-get) for full documentation. ## Examples ``` javascript var getRepos = require( '@kgryte/github-repos' ); var token, opts; token = 'tkjorjk34ek3nj4!'; opts = { 'interval': 10000 // ms }; function onError( evt ) { console.error( evt ); } function onRequest( evt ) { console.log( evt ); } function onPage( evt ) { var pct = evt.count / evt.total * 100; console.log( 'Query %d progress: %d%.' , evt.qid, Math.round( pct ) ); } function onData( evt ) { console.log( evt.data ); } function onEnd( evt ) { console.log( 'Query %d ended...', evt.qid ); console.dir( evt.ratelimit ); } var query = getRepos( token, opts ); query.on( 'error', onError ); query.on( 'request', onRequest ); query.on( 'page', onPage ); query.on( 'data', onData ); query.on( 'end', onEnd ); // Stop polling after 60 seconds... setTimeout( function stop() { query.stop(); }, 60000 ); ``` To run the example code from the top-level application directory, ``` bash $ node ./examples/index.js ``` __Note__: in order to run the example, you will need to obtain a personal access [token](https://github.com/settings/tokens/new) and modify the `token` value accordingly. --- ## CLI ### Installation To use the module as a general utility, install the module globally ``` bash $ npm install -g @kgryte/github-repos ``` ### Usage ``` bash Usage: github-repos [options] Options: -h, --help Print this message. -V, --version Print the package version. --token [token] Github personal access token. --interval [ms] Poll interval (in milliseconds). ``` ### Notes * In addition to the command-line `token` option, the token may also be specified by a `GITHUB_TOKEN` environment variable. The command-line option __always__ takes precedence. * If the process receives a terminating [signal event](https://nodejs.org/api/process.html#process_signal_events) (e.g., `CTRL+C`) while polling a Github API endpoint, the process will stop polling and wait for any pending requests to complete before exiting. ### Examples Setting the personal access [token](https://github.com/settings/tokens/new) using the command-line option: ``` bash $ github-repos --token <token> # => '[{..},{..},...]' ``` Setting the personal access [token](https://github.com/settings/tokens/new) using an environment variable: ``` bash $ GITHUB_TOKEN=<token> github-repos --interval 60000 # => '[{...},{...},...]' ``` For local installations, modify the command to point to the local installation directory; e.g., ``` bash $ ./node_modules/.bin/github-repos --token <token> ``` Or, if you have cloned this repository and run `npm install`, modify the command to point to the executable; e.g., ``` bash $ node ./bin/cli --token <token> ``` --- ## Tests ### Unit Unit tests use the [Mocha](http://mochajs.org/) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory: ``` bash $ make test ``` All new feature development should have corresponding unit tests to validate correct functionality. ### Test Coverage This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory: ``` bash $ make test-cov ``` Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report, ``` bash $ make view-cov ``` --- ## License [MIT license](http://opensource.org/licenses/MIT). ## Copyright Copyright &copy; 2015. Athan Reines. [npm-image]: http://img.shields.io/npm/v/@kgryte/github-repos.svg [npm-url]: https://npmjs.org/package/@kgryte/github-repos [travis-image]: http://img.shields.io/travis/kgryte/github-repos/master.svg [travis-url]: https://travis-ci.org/kgryte/github-repos [coveralls-image]: https://img.shields.io/coveralls/kgryte/github-repos/master.svg [coveralls-url]: https://coveralls.io/r/kgryte/github-repos?branch=master [dependencies-image]: http://img.shields.io/david/kgryte/github-repos.svg [dependencies-url]: https://david-dm.org/kgryte/github-repos [dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/github-repos.svg [dev-dependencies-url]: https://david-dm.org/dev/kgryte/github-repos [github-issues-image]: http://img.shields.io/github/issues/kgryte/github-repos.svg [github-issues-url]: https://github.com/kgryte/github-repos/issues
评论
    相关推荐
    • github上传
      这是您的模板存储库! 您将在changes分支中进行所有更改。 该存储库已获得 (c)2019 GitHub,Inc.的许可。
    • images:GitHub图像存储
      图片 GitHub图像存储 jsdelivr CDN
    • GitHub
      储存对象 Este proyecto se encarga de manejar losplanes de la liga de la justicia 诺塔斯 小学一年级数学上册期末试卷小学奥数网...
    • 测试github存储
      测试github存储
    • github测试
      github测试 我正在学习如何使用GitHub,这是我的第一个“真实”文件上传。 这组句子是从我的本地存储库创建的。 手指交叉,将其推送到远程仓库。
    • GitHubApp
      GitHubApp 创建具有两个屏幕的应用程序 -屏幕1:应具有您的Github个人资料。 使用响应中的至少4个字段来更新视图。... -屏幕2:使用从您的个人资料获得的存储库填充recyclerView。 每个项目视图中至少要使用3个字段。
    • github-traffic-stats:一个小的Python项目,使用GitHub API提取和存储GitHub项目的流量统计
      一个小型的Python项目,用于使用GitHub API提取和存储GitHub项目的流量统计信息。 目前,GitHub仅向仓库提供14天的流量数据。 该数据包括每天的观看次数和唯一身份访问者人数。 但是,如果您要存储和查看超过14天...
    • github-linkify
      浏览器扩展,显示指向GitHub配置文件和GitHub页面中存储库的链接 GitHub档案和回购链接有时位于最前面,但并非总是如此。 该扩展程序会在您访问GitHub Pages网站时进行检测,并在地址栏中添加指向相应配置文件或...
    • GitHits:永久存储GitHub的流量见解
      一个GitHub动作,用于*永久存储GitHub生成的流量信息,即视图和计数。 * GitHub仅提供14天之内的流量洞察。 此GitHub Action旨在克服该限制。 专为与使用而。 用法 创建/检索具有存储库级别访问权限的个人访问...