dotenv-caster

dotenv-caster is a tiny package that converts string | undefined to certain primitive types.

HTML Documentation Generated by typedoc

https://myxogastria0808.github.io/dotenv-caster/

Test Result Generated by @vitest/coverage-v8

https://myxogastria0808.github.io/dotenv-caster/coverage/

Test Coverage Generated by @vitest/ui

https://myxogastria0808.github.io/dotenv-caster/html/

DeepWiki

https://deepwiki.com/Myxogastria0808/dotenv-caster/

How to Use

This is an example of use if the following is written in .env.

STRING_SAMPLE=Hello
NUMBER_SAMPLE=0
BIGINT_SAMPLE=1234567890123456789012345678901234567890
SYMBOL_SAMPLE=SYMBOL
BOOLEAN_SAMPLE=true
NULL_SAMPLE=null

Copy

The following is an example of use. dotenv-caster is intended for use in projects that use dotenv.

import * as dotenv from 'dotenv';
// Import dotenv-caster
import { DotEnvCaster } from 'dotenv-caster';

dotenv.config();

// Create an instance
const dotenvCaster = new DotEnvCaster();

// string | undefined -> string
const stringSample: string = dotenvCaster.castString(process.env.STRING_SAMPLE);
// string | undefined -> number
const numberSample: number = dotenvCaster.castNumber(process.env.NUMBER_SAMPLE);
// string | undefined -> bigint
const bigIntSample: bigint = dotenvCaster.castBigInt(process.env.BIGINT_SAMPLE);
// string | undefined -> symbol
const symbolSample: symbol = dotenvCaster.castSymbol(process.env.SYMBOL_SAMPLE);
// string | undefined -> boolean
const booleanSample: boolean = dotenvCaster.castBoolean(process.env.BOOLEAN_SAMPLE);
// string | undefined -> null
const nullSample: null = dotenvCaster.castNull(process.env.NULL_SAMPLE);
Copy

Detail

Create an instance

When using dotenv-caster, first import dotenv-caster and create an instance as follows.

// Import dotenv-caster
import { DotEnvCaster } from 'dotenv-caster';

// Create an instance
const dotenvCaster = new DotEnvCaster();
Copy

string | undefined → string

// string | undefined -> string
const stringSample: string = dotenvCaster.castString(process.env.STRING_SAMPLE);
Copy

string | undefined → number

// string | undefined -> number
const numberSample: number = dotenvCaster.castNumber(process.env.NUMBER_SAMPLE);
Copy

string | undefined → bigint

// string | undefined -> bigint
const bigIntSample: bigint = dotenvCaster.castBigInt(process.env.BIGINT_SAMPLE);
Copy

string | undefined → symbol

// string | undefined -> symbol
const symbolSample: symbol = dotenvCaster.castSymbol(process.env.SYMBOL_SAMPLE);
Copy

string | undefined → boolean

// string | undefined -> boolean
const booleanSample: boolean = dotenvCaster.castBoolean(process.env.BOOLEAN_SAMPLE);
Copy

string | undefined → null

// string | undefined -> null
const nullSample: null = dotenvCaster.castNull(process.env.NULL_SAMPLE);
Copy