springroll.pbskids.EventSignature Class

Defined in: springroll.pbskids.EventSignature:11
Module: Learning

Define the signature of the api

Constructor

springroll.pbskids.EventSignature

(
  • api
  • [args]
  • [info]
)
private

Defined in springroll.pbskids.EventSignature:11

Parameters:

  • api String

    The name of the API

  • [args] Array optional

    The list of arguments to be called

  • [info] String optional

    The info description of the API

_argsDocs

(
  • args
  • ignoreNames
)
String
private

Defined in _argsDocs:105

Create the markup for the arguments

Parameters:

  • args Array

    The list of arguments

  • ignoreNames Array

    Ignore any name matching these collection of string

Returns:

String:

The markup

_format

(
  • args
  • [indent="\t"]
)
String
private

Defined in _format:173

Get the api signature of a method

Parameters:

  • args Array

    The API arguments

  • [indent="\t"] String optional

    The indentation

Returns:

String:

The signature api

docs

()

Defined in docs:84

Generate documentation, development build only!

hasProperty

(
  • property
  • [isEventArg=false]
)
Boolean

Defined in hasProperty:56

See if the event args or the api args has an property by name

Parameters:

  • property String

    The name of the argument

  • [isEventArg=false] Boolean optional

    If we're checking on the event args, default checks on the API arguments.

Returns:

Boolean:

If the property is found

toString

() String

Defined in toString:222

Get the string representation of the signature

Returns:

String:

The string version of the signature

api

String

Defined in api:28

The name of the method

args

Array

Defined in args:34

The arguments to be called by the API

eventArgs

Array

Defined in eventArgs:40

The arguments required by the spec

eventCode

String

Defined in eventCode:22

The event code

info

String

Defined in info:46

The API description