main.d.ts 745 B

1234567891011121314151617181920212223242526272829
  1. // TypeScript Version: 3.0
  2. /// <reference types="node" />
  3. export interface DotenvExpandOptions {
  4. ignoreProcessEnv?: boolean;
  5. error?: Error;
  6. parsed?: {
  7. [name: string]: string;
  8. }
  9. }
  10. export interface DotenvExpandOutput {
  11. ignoreProcessEnv?: boolean;
  12. error?: Error;
  13. parsed?: {
  14. [name: string]: string;
  15. };
  16. }
  17. /**
  18. * Adds variable expansion on top of dotenv.
  19. *
  20. * See https://docs.dotenv.org
  21. *
  22. * @param options - additional options. example: `{ ignoreProcessEnv: false, error: null, parsed: { { KEY: 'value' } }`
  23. * @returns an object with a `parsed` key if successful or `error` key if an error occurred. example: { parsed: { KEY: 'value' } }
  24. *
  25. */
  26. export function expand(options?: DotenvExpandOptions): DotenvExpandOutput