appBuckets - Phaser

Description

Phaser is a npm Module which allows you to create a log of all the actions you want. You can create some phases wtih an header title, which can cointain some subphases and tasks.
It allows you to create an error messagge if the task's promise is rejected;
A warning messagge or a complete messagge in case of success. Go ahead to see the fully documentation.

Task()

This is the class Phaser takes to create a Task. It has a constructor function and some other Method.

constructor(name, action, option)

The constructor is called with 3 parameters. Usually you can set only the first two.
When you set the Function action, the task wait the return state to continue the Log.

Params

• name
  • type: string
  • description: The name you want to assign at the Task
• action
  • type: Function
  • description: It is the function you want to execute and log its result. It can be a Promise or a normal function.

complete(result)

If a Task is returned with the complete() Method it means that it is successfully completed. You can pass as result parameter the result of the action.
This Method sets the status as 'Complete' and change the icon with the 'completed icon'.

Params

• result
  • type: any
  • description: You can pass as result the returned value of the action Function from the task constructor.

error(err)

If a Task is returned with the error() Method it means that an error is occurred.
You can pass as parameter a string to describe the Error.

Params

• err
  • type: String
  • description: This string is displayed in the Log as a description of the Error
  • default: Generic Error

warning(warn)

If a Task is returned with the warning() Method it means that a warning is occurred.
The Task is still successfully completed but a warning is displayed.

Params

• warn
  • type: Boolean
  • description: If it's 'true' the warning is saved in the tasks Array.

fatal(err)

If a Task is returned with the fatal() Method it means that a fatal error is occurred.
You can pass as parameter a string to describe the Error.

Params

• err
  • type: String
  • description: This string is displayed in the Log as a description of the Error
  • default: Generic Error

counter(name, initial, state)

This Method return a set of utility to change the counter. That counter will be
returned while generating the status. It can be Incremented or Decremented.

Params

• name
  • type: String
  • description: The Name of the counter
• initial
  • type: Number
  • description: The initial value of the Counter. By default it is zero
  • default: 0
• state
  • type: String
  • description: The state of the Counter. It can be 'normal', 'warning' or 'error'
  • default: normal

Phaser()

In This section are contained all the Methods Phaser has got.
It uses Task and Writer to create a log in the console, but he has got
many other usefull Methods.

constructor(description, options, parent)

The constructor creates a new Phaser object.

Params

• description
  • type: String
  • description: The title of the new Phase
• options
  • type: Object
  • description: Some options for the Phase
  • autoStart
    • type: Boolean
    • description: If it is 'true' the Phase will start automatically, otherwise it requires to call the start() Method
    • default: false
• parent
  • type: Class
  • description: The Phase class to attach the new Phase

Child(description, options)

This Method return a new Phaser Object attached to the main Phase parent
and called with the correct parameter. This will be a subPhase.

Params

• description
  • type: String
  • description: The description of the new Phase
• options
  • type: Object
  • description: Some options for the Phase

task(name, exec, options)

This Method return a new Task Object, called with the correct parameters return
a new task in the final log.

Params

• name
  • type: string
  • description: The name of the Task
• exec
  • type: Function
  • description: This is the Promise Function; the Task will return the result of this Promise Function.
  • task
    • type: Class
    • description: The task to append to
    • default: this.task
  • phaser
    • type: Class
    • description: The Phaser which is the parent of the Task
    • default: this.phaser
• options
  • type: Object
  • description: Some options for the new Task
  • silent
    • type: Boolean
    • description: If it is setted as 'true', it will does not show the start or end message in the log

start()

This Method is required, at the end of the code, to start the Phase. You can put it after all the code which generate the Log. It does not require any parameters.

Examples

  // All the code to generate the Log

  myPhase.start(); // It will start the Phase called 'myPhase'

error()

This Method return a Phaser error, which is different by the Task.error(). After you call the error Method it will stop all the Tasks, it will clear the queue and it will render the error.
If the error is not 'fatal' it will write the error message and continue to other Phase, otherwise it will stop all the Phase.

waitAllTasks()

This Method expects all tasks in the Phase to be resolved before generating the Log. It is usually called with the start() Method.

Examples

  // All the code to generate the Log

  myPhase.start().waitAllTask(); // It will wait the resolution of all the Tasks

Writer()

This Module is used by Phaser() and Task() to write all the information in the console. It contains the class Writer and some Methods for any type of message you need to print in the console.

constructor(generation, transporter)

The constructor sets the correct options to use all the Methods.

Params

• generation
  • type: Number
  • description: It will build a new Writer using the generation index
  • default: 0
• transporter
  • type: Function
  • description: The writer to use
  • default: Writer.writer

write(messagge, options)

This Method write a formatted message, using Writer transportee options

Params

• message
  • type: String
  • description: The message to display
• options
  • type: Object
  • description: The options transporter for the writer
  • default: IWriterOptions

header(content, subheader)

This Method return an header content. If it is the first generation, the header
will be full size and styled, else the writer will build a new header taking a subheader.

Params

• content
  • type: String
  • description: The name of the Header
• subheader
  • type: String
  • description: The Subheader to attached to

footer(content, description)

This Method return a footer content. If it is the first generation, the footer
will be styled, else the writer will create a new footer.

Params

• content
  • type: String
  • description: The content of the footer
• description
  • type: String
  • description: The description of the footer

log()

This Method return the log message you want to write in the console. Below are all the types of Message you can print in the console. They all requires the String message and an options parameter which, by default, is the writer options Object, it contains color and icon params.

• info
  • type: Function
  • description: This Function return an Info Message in the console.
  • message
    • type: String
    • description: The message you want to write
  • options
    • type: Object
    • description: The color and icon options for the message
    • default: IWriterOptions
• success
  • type: Function
  • description: This Function return a Success Message in the console.
  • message
    • type: String
    • description: The message you want to write
  • options
    • type: Object
    • description: The color and icon options for the message
    • default: IWriterOptions
• warning
  • type: Function
  • description: This Function return a Warning Message in the console.
  • message
    • type: String
    • description: The message you want to write
  • options
    • type: Object
    • description: The color and icon options for the message
    • default: IWriterOptions
• error
  • type: Function
  • description: This Function return an Error Message in the console.
  • message
    • type: String
    • description: The message you want to write
  • options
    • type: Object
    • description: The color and icon options for the message
    • default: IWriterOptions
• fatal
  • type: Function
  • description: This Function return a Fatal Error Message in the console.
  • message
    • type: String
    • description: The message you want to write
  • options
    • type: Object
    • description: The color and icon options for the message
    • default: IWriterOptions
• running
  • type: Function
  • description: This Function return a Running Message in the console.
  • message
    • type: String
    • description: The message you want to write
  • options
    • type: Object
    • description: The color and icon options for the message
    • default: IWriterOptions