summaryrefslogtreecommitdiff
path: root/node_modules/path-key/index.d.ts
diff options
context:
space:
mode:
authorLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
committerLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
commit703e03aba33f234712206769f57717ba7d92d23d (patch)
tree0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/path-key/index.d.ts
parentab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff)
downloadFlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz
FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst
Added export_allowed file to make repository visible in cgit
Diffstat (limited to 'node_modules/path-key/index.d.ts')
-rw-r--r--node_modules/path-key/index.d.ts40
1 files changed, 40 insertions, 0 deletions
diff --git a/node_modules/path-key/index.d.ts b/node_modules/path-key/index.d.ts
new file mode 100644
index 0000000..7c575d1
--- /dev/null
+++ b/node_modules/path-key/index.d.ts
@@ -0,0 +1,40 @@
+/// <reference types="node" />
+
+declare namespace pathKey {
+ interface Options {
+ /**
+ Use a custom environment variables object. Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env).
+ */
+ readonly env?: {[key: string]: string | undefined};
+
+ /**
+ Get the PATH key for a specific platform. Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform).
+ */
+ readonly platform?: NodeJS.Platform;
+ }
+}
+
+declare const pathKey: {
+ /**
+ Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform.
+
+ @example
+ ```
+ import pathKey = require('path-key');
+
+ const key = pathKey();
+ //=> 'PATH'
+
+ const PATH = process.env[key];
+ //=> '/usr/local/bin:/usr/bin:/bin'
+ ```
+ */
+ (options?: pathKey.Options): string;
+
+ // TODO: Remove this for the next major release, refactor the whole definition to:
+ // declare function pathKey(options?: pathKey.Options): string;
+ // export = pathKey;
+ default: typeof pathKey;
+};
+
+export = pathKey;