resource-creature

example resource for creatures like dragons, unicorns, and ponies

npm install resource-creature
8 downloads in the last month

creature

example resource for creatures like dragons, unicorns, and ponies

API

properties

methods

properties

example resource for creatures like dragons, unicorns, and ponies

  • id

    • type : any
  • type

    • type : string

    • enum

      • 0 : dragon

      • 1 : unicorn

      • 2 : pony

    • default : dragon

  • life

    • type : number

    • default : 10

  • isAwesome

    • type : boolean

    • default : true

methods

creature.create(options, callback)

create a new creature

  • options

    • type : object

    • properties

      • id

        • type : any
      • type

        • type : string

        • enum

          • 0 : dragon

          • 1 : unicorn

          • 2 : pony

        • default : dragon

      • life

        • type : number

        • default : 10

      • isAwesome

        • type : boolean

        • default : true

  • callback

    • type : function

creature.get(id, callback)

get creature by id

  • id

    • type : any

    • description : the id of the object

    • required : true

  • callback

    • type : function

creature.find(options, callback)

search for instances of creature

  • options

    • type : object

    • properties

      • id

        • type : any

        • default :

        • required : false

      • type

        • type : any

        • default :

        • required : false

      • life

        • type : any

        • default :

        • required : false

      • isAwesome

        • type : any

        • default :

        • required : false

  • callback

    • type : function

creature.all(callback)

gets all instances of creature

  • callback

    • type : function

creature.update(options, callback)

updates a creature by id

  • options

    • type : object

    • properties

      • id

        • type : any
      • type

        • type : string

        • enum

          • 0 : dragon

          • 1 : unicorn

          • 2 : pony

        • default : dragon

      • life

        • type : number

        • default : 10

      • isAwesome

        • type : boolean

        • default : true

  • callback

    • type : function

creature.updateOrCreate(options, callback)

updates a creature by id, and creates if necessary

  • options

    • type : object

    • properties

      • id

        • type : any
      • type

        • type : string

        • enum

          • 0 : dragon

          • 1 : unicorn

          • 2 : pony

        • default : dragon

      • life

        • type : number

        • default : 10

      • isAwesome

        • type : boolean

        • default : true

  • callback

    • type : function

creature.destroy(id, callback)

destroys a creature by id

  • id

    • type : string

    • description : the id of the object

    • required : true

  • callback

    • type : function

creature.poke()

creature.fire(options)

fires a lazer at a certain power and direction

  • options

    • type : object

    • properties

      • power

        • type : number

        • default : 1

        • required : true

      • direction

        • type : string

        • enum

          • 0 : up

          • 1 : down

          • 2 : left

          • 3 : right

        • required : true

        • default : up

    • callback

      • type : function

      • required : false

creature.talk(text)

echos back a string

  • text

    • type : string

    • default : hello!

    • required : true

README auto-generated with docs

npm loves you