module module

Per-file execution context.

index

class module

• module:poll()  – check when the module source has last changed.
• module:name(full)  – get the module name.
• module:slurp()  – get the module contents.
• module:spit(str)  – update the module contents.
• module:eval(parent_scope)  – start an evaluation cycle.
• module:rollback()  – rollback the last evaluation cycle.
• module:finish()  – finish the last evaluation cycle.
• module:destroy()  – destroy this module.
• module.ast  – the last updated AST tree for this module.
• module.root  – the runtime graph root of this module.

class fsmodule

• FSModule(file)  – create a new FSModule.

class stringmodule

• StringModule(name_, source)  – create a new StringModule.

details

class module

• module:poll()  – check when the module source has last changed.

  returns:

  1. (number): timestamp of last change
• module:name(full)  – get the module name.

  parameters:

  • full (boolean): path

  returns:

  1. (string)
• module:slurp()  – get the module contents.

  returns:

  1. (string)
• module:spit(str)  – update the module contents.

  parameters:

  • str (string): the updated contents
• module:eval(parent_scope)  – start an evaluation cycle.
  If the module has already been evaluated this tick, this is a noop. Otherwise, register the module with the Copilot. Updates root.

  parameters:

  • parent_scope
• module:rollback()  – rollback the last evaluation cycle.
• module:finish()  – finish the last evaluation cycle.
• module:destroy()  – destroy this module.
• module.ast  – the last updated AST tree for this module.
  • ast (optional AST)
• module.root  – the runtime graph root of this module.
  • root (optional RTNode)

class fsmodule

• FSModule(file)  – create a new FSModule.

  parameters:

  • file (string): filepath

class stringmodule

• StringModule(name_, source)  – create a new StringModule.

  parameters:

  • name_ (string): module name
  • source (string): module source code