npm-registry-client API sketch

nrc-api

## SUMMARY

* request
* get

* adduser
* bugs
* deprecate
* fetch
* publish
* star
* stars
* tag
* unpublish
* upload

## METHODS

`+` denotes required parameter
`-` denotes private data added to params by call

`name:Type[=default]`

adduser(uri, params, cb)
  +uri:String
  +params:Object
    +auth:Credentials
  +cb:Function

bugs(uri, params, cb)
  +uri:String
  +params:Object
    auth:Credentials
  +cb:Function

deprecate(uri, params, cb)
  +uri:String
  +params:Object
    +version:Semver
    +message:String
    +auth:Credentials
  +cb:Function

get(uri, params, cb)
  +uri:String
  +params:Object
    timeout:Number=-1
    follow:Boolean=false
    staleOk:Boolean=false
    auth:credentials
    -stat:fs.Stats
    -data:Object
  +cb:Function

publish(uri, params, cb)
  +uri:String
  +params:Object
    +metadata:Object
    +body:Stream
    +auth:Credentials
  +cb:Function

star(uri, params, cb)
  +uri:String
  +params:Object
    starred:Boolean=false
    +auth:Credentials
  +cb:Function

stars(uri, params, cb)
  +uri:String
  +params:Object
    +username:String
    auth:Credentials
  +cb:Function

tag(uri, params, cb)
  +uri:String
  +params:Object
    +version:String
    +tag:String
    +auth:Credentials
  +cb:Function

unpublish(uri, params, cb)
  +uri:String
  +params:Object
    version:String=delete all versions
    +auth:Credentials
  +cb:Function

whoami(uri, params, cb)
  +uri:String
  +params:Object
    +auth:Credentials
  +cb:Function

## PLUMBING

request(uri, params, cb)
  +uri:String
  +params:Object
    method:String="GET"
    body:Stream|Buffer|String|Object=operation is read-only
    etag:String
    follow:Boolean=true
    auth:Credentials={}
  +cb:Function

fetch(uri, params, cb)
  +uri:String
  +params:Object
    headers:Object={}
    +auth:Credentials={}
  +cb:Function

upload(uri, params, cb)
  +uri:String
  +params:Object
    +body:Stream
    etag:String
    follow:Boolean=true
    +auth:Credentials
  +cb:Function

👍