UNPKG

@stryke/types

Version:

A package containing many base TypeScript type definitions that are shared across many projects.

stormsoftware.com

71 lines • 3.19 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
//#region src/configuration.d.ts /** * A reference to something (example: value, configuration, type definition, schema, etc.) in a file */ interface FileReference { /** * A path to a file containing the reference */ file: string; /** * The name of the exported entity in the file above * * @remarks * This value is mainly expected for use with javascript/typescript files. If no value is provided, we will attempt to infer the exported entity from the module's `default` export. */ export?: string; } /** * Configuration parameter for the {@link FileReference} utility type * * @remarks * When provided as a string, this value can include both a path to the typescript file and the name of the type definition to use separated by a `":"`, `"#"`, or `";"` character. For example: `"./src/types/env.ts#EnvConfiguration"`. */ type FileReferenceInput = FileReference | string; interface DotenvFileReference { /** * A path to the type definition for the expected env configuration parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"`, `"#"`, `";"` character. For example: `"./src/types/env.ts#Variables"`. * * @remarks * If a value is not provided for this option, the plugin will attempt to infer the type definition from the `storm.dotenv.types.config` object in the project's `package.json` file. */ variables?: FileReferenceInput; /** * A path to the type definition for the expected env secret parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"`, `"#"`, `";"` character. For example: `"./src/types/env.ts#Secrets"`. * * @remarks * If a value is not provided for this option, the plugin will attempt to infer the type definition from the `storm.dotenv.types.secrets` object in the project's `package.json` file. */ secrets?: FileReferenceInput; } interface DotenvConfiguration { /** * Additional environment variable (.env) files (aside from the default list of files) to load configuration from. * * @remarks * By default, the plugin will load environment variables from `.env` files based on the `mode`. For the `"production"` mode, it will use the following files: * - `.env` * - `.env.local` * - `.env.production` * - `.env.production.local` */ additionalFiles?: string[]; /** * The type definitions for the environment variables * * @remarks * This value can be a {@link DotenvFileReference} or just a path to a typescript file and the `"name"` values are defaulted to the following: * - {@link DotenvFileReference.variables} - `"Variables"` * - {@link DotenvFileReference.secrets} - `"Secrets"` */ types?: DotenvFileReference | string; } interface StormConfigurationGroups { /** * The configuration for the loading variable and secrets into the environment via `.env` files */ dotenv?: DotenvConfiguration; } //#endregion export { DotenvConfiguration, DotenvFileReference, FileReference, FileReferenceInput, StormConfigurationGroups }; //# sourceMappingURL=configuration.d.mts.map