Vloop API
    Preparing search index...

    Interface Vloop

    interface Vloop {
        resume: (callRef: VloopCall | VloopCallRef) => VloopCall;
        start: (
            source: string,
            params?: unknown,
            options?: Record<string, never>,
        ) => VloopCall;
        startOrResume: (
            source: string,
            params?: unknown,
            options?: { key?: string },
        ) => VloopCall;
    }
    Index
    resume start startOrResume
    resume: (callRef: VloopCall | VloopCallRef) => VloopCall

    Type Declaration

    start: (
        source: string,
        params?: unknown,
        options?: Record<string, never>,
    ) => VloopCall

    Type Declaration

      • (source: string, params?: unknown, options?: Record<string, never>): VloopCall

      • Starts a fresh child vloop and returns an awaitable, durable call handle.

        Parameters

        • source: string

          Runnable source or shorthand reference.

        • Optionalparams: unknown = {}

          JSON-compatible value passed to the child.

        • Optionaloptions: Record<string, never> = {}

          Reserved; must be empty. Use startOrResume for a keyed call.

        Returns VloopCall

    startOrResume: (
        source: string,
        params?: unknown,
        options?: { key?: string },
    ) => VloopCall

    Type Declaration

      • (source: string, params?: unknown, options?: { key?: string }): VloopCall

      • Starts one tagged child vloop or reconnects its saved call.

        Parameters

        • source: string

          Runnable source or shorthand reference.

        • Optionalparams: unknown = {}

          JSON-compatible value passed to the child.

        • Optionaloptions: { key?: string } = {}
          • Optionalkey?: string

            Defaults to source. Reusing a key requires the same source and params.

        Returns VloopCall

    Settings
    Member Visibility

    On This Page
    Properties