Documentation
    Preparing search index...

    Type Alias BaseConfigSchema

    type BaseConfigSchema = {
        envName?: string;
        schema: StandardSchemaV1<unknown, unknown>;
    }
    Index

    Properties

    Properties

    envName?: string

    When instancing the plugin with the fromEnv function, this is the name of the environment variable that you expect to contain the value for this option. The string value will be passed to the schema as input.

    schema: StandardSchemaV1<unknown, unknown>

    A Standard Schema-compatible schema, that can validate and transform the user's configuration into a usable format for the plugin.