acme-jsdoc-example

by lipp

master096fdae  created July 5th 2016

other versions

2
Modules
5
Classes
9
Functions

config

Kind
constant
Type
Scope
global

No description available.

Default:

{"company":"ACME TM"}

fx
fromCrawlkit

    Kind
    function
    Scope
    global

    From crawlkit.

    A method to get a function from that is evaluated within the web page and returns a result.

    The returned function should call back with an result of any serializable kind by calling window.callPhantom(error, result). If your method did not provoke an error, pass null as the first argument.

    The time out of the returned function is controlled via greet.

    The returned function will be called immediately after page load, any defined config and other greetss added before.

    Returns:

    1. A function to be evaluated within the crawled webpage

    See:

    greet

    Kind
    constant
    Type
    Scope
    global

    This is just a constant. You can attach interactive playgrounds with the @playground tag. You can require any npm module and write real programs.

    Default:

    'Hello folks!'

    Playgrounds:

    funnyCoyote
    • name
    • options

    Kind
    class
    Scope
    inner

    Creates a new Coyote instance.

    A coyote is a real funny animal, which likes to place bombs or to skate on rails with rockets.

    Arguments:

    1. name

      The name like 'chuck' or 'berry'

    2. optionsoptional, default: {defaultTool: 'hammer'}

      Optional config params.

      • ageoptional

        The age in years

      • defaultTooloptional

        The default tool to use

      • suboptional

        very special params

        • deltaoptional

          Some crazy delta

    Instance Members:

    fx
    funnyCoyote#getTool

      Kind
      function
      Scope
      instance

      Get the current tool.

      Returns:

      1. The current tool in use.

      fx
      funnyCoyote#setTool
      • tool

      Kind
      function
      Scope
      instance

      Set the current tool.

      Arguments:

      1. tool

        The new tool to use. Is copied.

      fx
      funnyCoyote#skate
      • speed

      Kind
      function
      Scope
      instance

      Start skating on rails. You should call this whenever possible, also after using the Tool.

      Arguments:

      1. speedoptional, default: 50

        in mps

      heavyBall
      • options

      Kind
      class
      Scope
      inner
      Deprecated
      yes

      A lame ball class. Not so much fun.

      Arguments:

      1. options

      fx
      heavyBomb#action
      • mode

      Kind
      function
      Scope
      instance

      Explode on the spot.

      Arguments:

      1. modeoptional, default: actionMode.MEDIUM

        The mode to use to perform the action

      heavyHammer

        Kind
        class
        Since
        1.0.1
        Implements
        Scope
        inner

        Create a hammer tool, to smash stuff.

        Instance Members:

        fx
        heavyHammer#action
        • mode

        Kind
        function
        Scope
        instance

        Smash all near stuff.

        Arguments:

        1. modeoptional, default: heavy~actionMode.MEDIUM

          The mode to use to perform the action

        heavyTool

        Kind
        interface
        Scope
        inner

        Interface for all tools.

        There are different Tool implementations available for use.

        What you can expect

        • have fun
        • destroy things
        • going crazy

        What you can NOT expect

        • do something useful
        • catching the Road Runner

        Example

        coyote.setTool(...)
        coyote.getTool().action()

        Static Members:

        Instance Members:

        fx
        heavyTool#action
        • mode

        Kind
        function
        Scope
        instance

        Perform the tool associated action like explode, SMASH!, zooom respectively.

        Arguments:

        1. modeoptional, default: Tool.actionMode.MEDIUM

          The mode to use to perform the action

        fx
        heavyTool#tojQueryPlugin

          Kind
          function
          Scope
          instance

          Turns this tool into a nice jQuery plugin

          Returns:

          1. The new plugin instance

          heavyTool.actionMode

          Kind
          member
          Type
          Scope
          static

          Enum for performing action.

          Properties:

          1. SLOW, default: 0

          2. MEDIUM, default: 1

          3. FAST, default: 2

          heavyTool.actionMode.FAST

          Kind
          member
          Type
          Scope
          static

          No description available.

          Default:

          2

          heavyTool.actionMode.MEDIUM

          Kind
          member
          Type
          Scope
          static

          No description available.

          Default:

          1

          heavyTool.actionMode.SLOW

          Kind
          member
          Type
          Scope
          static

          No description available.

          Default:

          0