Interface TypefusionScriptEffect<DataElement>

The type of a Typefusion script export (TypefusionScriptExport) when the result of the runEffect 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 TypefusionScriptEffect<DataElement> {
    name: string;
    resultDatabase: TypefusionSupportedDatabases;
    run?: (() => PromiseLike<TypefusionScriptResult<unknown>>);
    runEffect: (<R>() => Effect<TypefusionScriptResult<DataElement>, any, R>);
    schema: {
        [key in string | number | symbol]: DbType<DataElement[key]>
    };
}

Type Parameters

DataElement extends Record<string, unknown>

Hierarchy (view full)

TypefusionScriptExport
- TypefusionScriptEffect
  - TypefusionScriptUnknownEffect

Index

Properties

name resultDatabase run? runEffect schema

Properties

name

name: string

resultDatabase

resultDatabase: TypefusionSupportedDatabases

`Optional`run

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

runEffect

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

schema

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