Interface TypefusionScript<DataElement>

The type of a Typefusion script export (TypefusionScriptExport) when the result of the run function contains both the 'schema' and return data. This will check that your pgType schema matches the data you are returning, but it's more verbose than using TypefusionDbScript.

interface TypefusionScript<DataElement extends Record<string, unknown>> {
    name: string;
    resultDatabase: TypefusionSupportedDatabases;
    run: () => PromiseLike<TypefusionScriptResult<DataElement>>;
    runEffect?: <R extends TypefusionContextEffect>() => Effect<
        TypefusionScriptResult<unknown>,
        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

run

run: () => PromiseLike<TypefusionScriptResult<DataElement>>

OptionalrunEffect

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

schema

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

Settings

Member Visibility

On This Page

Properties