npm-test-md v1.0.1

Classes

Functions

ExportedClass

a class exported from a module

Kind: global class

• ExportedClass
  • new ExportedClass(one, two)
  • instance
    • .propOne : number
    • .methodOne()
    • .methodTwo()
  • static
    • .shat()

new ExportedClass(one, two)

the class constructor

Throws:

• string A serious error occurred.

Example

var one = 1

exportedClass.propOne : number

an instance property

Kind: instance property of ExportedClass

exportedClass.methodOne()

parent method one

Kind: instance method of ExportedClass

exportedClass.methodTwo()

parent method two

Kind: instance method of ExportedClass

ExportedClass.shat()

a static method

Kind: static method of ExportedClass

ChildClass ⇐ ExportedClass

the child of exported class

Kind: global class
Extends: ExportedClass

• ChildClass ⇐ ExportedClass
  • .propThree
  • .propOne : number
  • .methodOne()
  • .methodTwo()

childClass.propThree

an instance property

Kind: instance property of ChildClass

childClass.propOne : number

an instance property

Kind: instance property of ChildClass

childClass.methodOne()

parent method one

Kind: instance method of ChildClass

childClass.methodTwo()

parent method two

Kind: instance method of ChildClass

paramDefaults(option)

Lots of params with default values.

Kind: global function