Skip to content

Latest commit

 

History

History
95 lines (72 loc) · 2.27 KB

configure.md

File metadata and controls

95 lines (72 loc) · 2.27 KB
Raw

Configure

Allows easily setting application configs using JSON rather than environment-variables.

Getting Started

First, create a file config.json at your application's root.
By default debug and error_log are set to these values.
If you want to change them, this is the place where to do it!

{
  "debug": false,
  "error_log": "logs/error.logs"
}

Then import the module as part of Chomp's core and load the configure:

import * from "https://deno.land/x/chomp/mod.ts";

await Configure.load();

Although, if you want to use a more minimal setup:

import { Configure } from "https://deno.land/x/chomp/mod.ts";

await Configure.load();

Getting an item from the Configure

Getting an item from the Configure can be done by calling Configure.get().
Doing this will return either the value set in the configure or null.

const myConst = Configure.get('app configure item');

If you want to have a default return value, then you can specify it as follows:

const myConst = Configure.get('app configure item', 'default value');

Setting or updating an item in the Configure

NOTE: Changes made here do not persist between restarts of your app.

Checking whether an item exists

Consume a Configure item

Delete a Configure item

Dump all Configure items

NOTE: This should only be done for debugging purposes as it may leak sensitive information!

Clear or reset all Configure items

Made a mistake or have another reason to start with a clean Configure? Then this can be done in two ways: Configure.clear() and Configure.reset().

Configure.clear() will completely empty the configure:

console.log(Configure.dump());
Configure.clear();
console.log(Configure.dump());
Map(3) {
  "debug" => false,
  "error_log" => "/path/to/logs/error.log",
  "app configuration key" => "app configuration value"
}
Map(0) {}

Whereas Configure.clear() will reset the configure to it's default state:

console.log(Configure.dump());
Configure.reset();
console.log(Configure.dump());
Map(3) {
  "debug" => false,
  "error_log" => "/path/to/logs/error.log",
  "app configuration key" => "app configuration value"
}
Map(2) {
  "debug" => false, 
  "error_log" => "/path/to/logs/error.log"
}