iridium - v0.9a
    Preparing search index...

    Implements yield semantics. Yield can pass arguments which can be read as iterator/next values from the iterator function. When the flow resumes, the yieldDoneIndicator value is check to perform an early return otherwise the flow of the generator function continues until next pause.

    MDN reference

    function* foo() {
    yield "The";
    yield "World is";
    }

    const iterator = foo();
    console.log(iterator.next().value + " " + iterator.next().value + " " + iterator.next().value);
    <yieldDoneIndicator, yieldReturnResultHolder> = YIELD obj
    
    • ARG(obj): An object, likely a promise returned by an asynchronous function.

    • ARG(doneTarget): The target location for yieldDoneIndicator (usually ResolveEnvBindingSEXP before transition).

    • ARG(nextValue): The target location for yieldReturnResultHolder (usually ResolveEnvBindingSEXP before transition).

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • arg: string
      • yieldReturnIndicator: string
      • yieldReturnResultHolder: string

      Returns YieldSEXP

    Properties

    args: IridiumSEXP[] = []

    Args are the children nodes to the current node.

    flags: [string, IridiumPrimitives][] = []

    Flags store metadata/primitive data in an Iridium node. These nodes cannot store other Iridium S-Expressions.

    tag: string = "IridiumSEXP"

    Tag specifics the S-Expression Type.

    Methods

    • Parameters

      • flag: string

      Returns boolean

    • Parameters

      • flag: string

      Returns number

    • Parameters

      • flag: string

      Returns string

    • Parameters

      • flag: string

      Returns boolean

    • Parameters

      • flag: string

      Returns void

    • This method is used to squish the Iridium Code into an array which can be easily stored on disk.

      Returns any[]

      Nested Array of Iridium S-Expressions.

    • Parameters

      • Optionalspace: number

      Returns string