diff --git a/env-to-object/env-to-object-tests.ts b/env-to-object/env-to-object-tests.ts new file mode 100644 index 0000000000..e2c1fd4e53 --- /dev/null +++ b/env-to-object/env-to-object-tests.ts @@ -0,0 +1,35 @@ +import * as envToObject from 'env-to-object'; + +const map = { + 'NODE_ENV': { + 'keypath': 'env', + 'type': 'string' + }, + 'PORT': { + 'keypath': 'server.port', + 'type': 'number' + }, + 'SSL': { + 'keypath': 'server.ssl', + 'type': 'boolean' + }, + 'LOG_LEVEL': { + 'keypath': 'logger.level', + 'type': 'string' + }, + 'INT': { + 'keypath': 'int', + 'type': 'integer', + 'radix': '2' + } +}; + +const result1:any = envToObject(map); +const result2:any = envToObject(map, { + parsers: { + 'my-custom-type': (str: string, opts: any) => { + let foo: any = JSON.parse(str); + return foo; + } + } +}); diff --git a/env-to-object/index.d.ts b/env-to-object/index.d.ts new file mode 100644 index 0000000000..1ec7a3c994 --- /dev/null +++ b/env-to-object/index.d.ts @@ -0,0 +1,39 @@ +// Type definitions for env-to-object 1.1 +// Project: https://github.com/kgryte/node-env-to-object#readme +// Definitions by: TANAKA Koichi +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace env { + export interface Mappings { + [enviromentVariableName: string]: Mapping; + } + + export type Mapping = IntegerMapping | BooleanMapping | GenericMapping; + + interface GenericMapping { + keypath: string; + type?: string; + [opt: string]: any; + } + + interface IntegerMapping extends GenericMapping { + type: "integer"; + radix: number; + } + + interface BooleanMapping { + type: "boolean"; + strict: boolean; + } + + export interface Parsers { + [parserName: string]: (str: string, opts: any) => any; + } + + export interface Options { + parsers: Parsers; + } +} + +declare function env(map: env.Mappings, options?: env.Options): any; +export = env; diff --git a/env-to-object/tsconfig.json b/env-to-object/tsconfig.json new file mode 100644 index 0000000000..68efe0c7ca --- /dev/null +++ b/env-to-object/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "env-to-object-tests.ts" + ] +} diff --git a/env-to-object/tslint.json b/env-to-object/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/env-to-object/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" }