resource-creature

example resource for creatures like dragons, unicorns, and ponies

creature

example resource for creatures like dragons, unicorns, and ponies

properties

methods

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

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

  • callback

    • type : function

get creature by id

  • id

    • type : any

    • description : the id of the object

    • required : true

  • callback

    • type : function

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

  • callback

    • type : function

gets all instances of creature

  • callback

    • type : function

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

  • callback

    • type : function

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

  • callback

    • type : function

destroys a creature by id

  • id

    • type : string

    • description : the id of the object

    • required : true

  • callback

    • type : function

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

echos back a string

  • text

    • type : string

    • default : hello!

    • required : true

README auto-generated with docs