Variable CodeEngineClientConst

CodeEngineClient: {
    getAllPackages: ((options?: {
        limit?: number;
        parts?: FunctionParts[];
        skip?: number;
    }) => Promise<any>);
    getAllVersions: ((packageId: string, options?: {
        limit?: number;
        parts?: FunctionParts[];
        skip?: number;
    }) => Promise<any>);
    getPackageById: ((packageId: string, options?: {
        parts?: FunctionParts[];
    }) => Promise<any>);
    getVersion: ((packageId: string, version: string, options?: {
        parts?: FunctionParts[];
    }) => Promise<any>);
    runFunction: ((packageId: string, version: string, functionName: string, inputs: {
        [key: string]: any;
    }, options?: {
        parts?: FunctionParts[];
    }) => Promise<any>);
} = ...

Namespace

Utilities for helping your app interact with Code Engine.

Example

import { CodeEngineClient } from @domoinc/toolkit;

const packageId = '12a45bc8-12de-fg67-891h-12ij567891kl';
const version = '0.1.0';
const functionName = 'myFunction';

// call client static methods
await CodeEngineClient.getVersion(
 packageId,
 version,
);

Type declaration

  • getAllPackages: ((options?: {
        limit?: number;
        parts?: FunctionParts[];
        skip?: number;
    }) => Promise<any>)
      • (options?: {
            limit?: number;
            parts?: FunctionParts[];
            skip?: number;
        }): Promise<any>

      • Parameters

        • Optional options: {
              limit?: number;
              parts?: FunctionParts[];
              skip?: number;
          }
          • Optional limit?: number
          • Optional parts?: FunctionParts[]
          • Optional skip?: number

        Returns Promise<any>

  • getAllVersions: ((packageId: string, options?: {
        limit?: number;
        parts?: FunctionParts[];
        skip?: number;
    }) => Promise<any>)
      • (packageId: string, options?: {
            limit?: number;
            parts?: FunctionParts[];
            skip?: number;
        }): Promise<any>

      • Parameters

        • packageId: string
        • Optional options: {
              limit?: number;
              parts?: FunctionParts[];
              skip?: number;
          }
          • Optional limit?: number
          • Optional parts?: FunctionParts[]
          • Optional skip?: number

        Returns Promise<any>

  • getPackageById: ((packageId: string, options?: {
        parts?: FunctionParts[];
    }) => Promise<any>)
      • (packageId: string, options?: {
            parts?: FunctionParts[];
        }): Promise<any>

      • Parameters

        • packageId: string
        • Optional options: {
              parts?: FunctionParts[];
          }
          • Optional parts?: FunctionParts[]

        Returns Promise<any>

  • getVersion: ((packageId: string, version: string, options?: {
        parts?: FunctionParts[];
    }) => Promise<any>)
      • (packageId: string, version: string, options?: {
            parts?: FunctionParts[];
        }): Promise<any>

      • Parameters

        • packageId: string
        • version: string
        • Optional options: {
              parts?: FunctionParts[];
          }
          • Optional parts?: FunctionParts[]

        Returns Promise<any>

  • runFunction: ((packageId: string, version: string, functionName: string, inputs: {
        [key: string]: any;
    }, options?: {
        parts?: FunctionParts[];
    }) => Promise<any>)
      • (packageId: string, version: string, functionName: string, inputs: {
            [key: string]: any;
        }, options?: {
            parts?: FunctionParts[];
        }): Promise<any>

      • Parameters

        • packageId: string
        • version: string
        • functionName: string
        • inputs: {
              [key: string]: any;
          }
          • [key: string]: any
        • Optional options: {
              parts?: FunctionParts[];
          }
          • Optional parts?: FunctionParts[]

        Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc