resource-permissions

for managing permissions

npm install resource-permissions
1 downloads in the last week
4 downloads in the last month

permissions

for managing permissions

API

properties

methods

properties

for managing permissions

  • id

    • type : any
  • accountID

    • type : string

    • default : my title

    • key : account

    • description : the account to apply permission to

  • event

    • type : string

    • description : the link to the permissions on a third party site

    • format : permissions

methods

permissions.create(options, callback)

create a new permissions

  • options

    • type : object

    • properties

      • id

        • type : any
      • accountID

        • type : string

        • default : my title

        • key : account

        • description : the account to apply permission to

      • event

        • type : string

        • description : the link to the permissions on a third party site

        • format : permissions

  • callback

    • type : function

permissions.get(id, callback)

get permissions by id

  • id

    • type : any

    • description : the id of the object

    • required : true

  • callback

    • type : function

permissions.find(options, callback)

search for instances of permissions

  • options

    • type : object

    • properties

      • id

        • type : any

        • default :

        • required : false

      • accountID

        • type : any

        • default :

        • key : account

        • description : the account to apply permission to

        • required : false

      • event

        • type : any

        • description : the link to the permissions on a third party site

        • default :

        • required : false

  • callback

    • type : function

permissions.all(callback)

gets all instances of permissions

  • callback

    • type : function

permissions.update(options, callback)

updates a permissions by id

  • options

    • type : object

    • properties

      • id

        • type : any
      • accountID

        • type : string

        • default : my title

        • key : account

        • description : the account to apply permission to

      • event

        • type : string

        • description : the link to the permissions on a third party site

        • format : permissions

  • callback

    • type : function

permissions.updateOrCreate(options, callback)

updates a permissions by id, and creates if necessary

  • options

    • type : object

    • properties

      • id

        • type : any
      • accountID

        • type : string

        • default : my title

        • key : account

        • description : the account to apply permission to

      • event

        • type : string

        • description : the link to the permissions on a third party site

        • format : permissions

  • callback

    • type : function

permissions.destroy(id, callback)

destroys a permissions by id

  • id

    • type : string

    • description : the id of the object

    • required : true

  • callback

    • type : function

README auto-generated with docs

npm loves you