@octokit/rest

v15.2.3
GitHub REST API client for Node.js
octokit github rest api-client

Readme Versions Dependencies Scripts

test

nyc mocha test/mocha-node-setup.js "test/**/*-test.js"

build

npm-run-all build:*

pretest

standard && standard-markdown

build:ts

node scripts/generate-typescript-types

coverage

nyc report --reporter=html && open coverage/index.html

build:docs

node scripts/generate-api-docs

build:flow

node scripts/generate-flow-types

deploy-docs

gh-pages-with-token -d doc

validate:ts

tsc --target es6 index.d.ts

test:browser

cypress run --browser chrome

build:browser

npm-run-all build:browser:*

prebuild:docs

mkdirp doc/

test:examples

node test/examples.js

postbuild:docs

apidoc -i doc/ -o doc/

prevalidate:ts

npm run -s build:ts

coverage:upload

nyc report --reporter=text-lcov | coveralls

postvalidate:ts

tsc --noEmit test/typescript-validate.ts

prebuild:browser

mkdirp dist/

semantic-release

semantic-release

start-fixtures-server

octokit-fixtures-server

generate-bundle-report

webpack-bundle-analyzer dist/bundle-stats.json --mode=static --no-open --report dist/bundle-report.html

build:browser:production

webpack --mode production --entry . --plugin=compression-webpack-plugin --output-library=Octokit --output-path=./dist --output-filename=octokit-rest.min.js --devtool source-map

build:browser:development

webpack --mode development --entry . --output-library=Octokit --output=./dist/octokit-rest.js --profile --json > dist/bundle-stats.json
npm i @octokit/[email protected]

Metadata

  • MIT
  • >=4
  • Gregor Martynus
  • released 3/15/2018

Downloads