updating-secrets - v0.3.1
    Preparing search index...

    Type Alias SecretsJsonFileAdapterOptions<Secrets>

    Options for SecretsJsonFileAdapter.

    type SecretsJsonFileAdapterOptions<Secrets extends SecretDefinitions = any> = {
        fsOverride: {
            existsSync: (filePath: string) => boolean;
            promises: {
                mkdir: (
                    filePath: string,
                    options?: { recursive: boolean },
                ) => Promise<void | string>;
                readFile: (filePath: string) => Promise<string | Buffer>;
                writeFile: (filePath: string, contents: string | Buffer) => Promise<void>;
            };
        };
        generateValues: (() => MaybePromise<SecretValues<Secrets>>)
        | undefined;
    }

    Type Parameters

    Index

    Properties

    fsOverride generateValues

    Properties

    fsOverride: {
        existsSync: (filePath: string) => boolean;
        promises: {
            mkdir: (
                filePath: string,
                options?: { recursive: boolean },
            ) => Promise<void | string>;
            readFile: (filePath: string) => Promise<string | Buffer>;
            writeFile: (filePath: string, contents: string | Buffer) => Promise<void>;
        };
    }

    Optional override for Node.js's fs for mocking, testing, or other purposes.

    Type declaration

    • existsSync: (filePath: string) => boolean

      existsSync from 'node:fs'

    • promises: {
          mkdir: (
              filePath: string,
              options?: { recursive: boolean },
          ) => Promise<void | string>;
          readFile: (filePath: string) => Promise<string | Buffer>;
          writeFile: (filePath: string, contents: string | Buffer) => Promise<void>;
      }

      'node:fs/promises'

      • mkdir: (filePath: string, options?: { recursive: boolean }) => Promise<void | string>

        mkdir from 'node:fs/promises'

      • readFile: (filePath: string) => Promise<string | Buffer>

        readFile from 'node:fs/promises'

      • writeFile: (filePath: string, contents: string | Buffer) => Promise<void>

        writeFile from 'node:fs/promises'

    import * as fs from 'node:fs';
    generateValues: (() => MaybePromise<SecretValues<Secrets>>) | undefined

    Optional function that will automatically generate and save new secrets if the JSON file is missing. This is particularly useful for dev or testing environments.

    Settings

    Member Visibility

    On This Page

    Properties