Interface TypefusionScriptDataOnlyEffect<DataElement>

The type of a Typefusion script export (TypefusionScriptExport) when the result of the runEffect function contains the data without any schema.

interface TypefusionScriptDataOnlyEffect<
    DataElement extends Record<string, unknown>,
> {
    name: string;
    resultDatabase: TypefusionSupportedDatabases;
    run?: () => PromiseLike<TypefusionScriptResult<unknown>>;
    runEffect: <R extends TypefusionContextEffect>() => Effect<
        TypefusionScriptResult<DataElement>,
        any,
        R,
    >;
    schema?: { [key in string | number | symbol]: DbType<DataElement[key]> };
}

Type Parameters

  • DataElement extends Record<string, unknown>

Hierarchy (View Summary)

Properties

name resultDatabase run? runEffect schema?

Properties

name

name: string

resultDatabase

resultDatabase: TypefusionSupportedDatabases

Optionalrun

run?: () => PromiseLike<TypefusionScriptResult<unknown>>

runEffect

runEffect: <R extends TypefusionContextEffect>() => Effect<
    TypefusionScriptResult<DataElement>,
    any,
    R,
>

Optionalschema

schema?: { [key in string | number | symbol]: DbType<DataElement[key]> }

Settings

Member Visibility

On This Page

Properties