0.7.142 • Published 3 years ago

@cloud-technology/parameter v0.7.142

Weekly downloads
-
License
BSD-2-Clause
Repository
github
Last release
3 years ago

@cloud-technology/parameter

A Zero-Dependency "Type-Interface" via Node.js

While intentionally ambiguous, parameter extends a primitive string. Specifically, the following utility methods are available to the Parameter class:

  • Parameter.format()
  • Parameter.string()
  • Parameter.enumerations()
  • Parameter.instantiate()
  • Parameter.create()

to follow an opinionated convention to be used in cloud-related

Parameters often used during configuration can be a difficult concept to standardize.

@cloud-technology/parameter aims to strictly define a naming and constructor convention to ease efforts associated with configuration, while allowing for an easy inheritance pattern to further extend from; examples of applicable extensions include usages with:

  • etcd
  • Hashicorp's vault
  • AWS Secure Systems Manager
  • AWS Secrets Manager
  • Microsoft Cloud Vault
  • GCP Credential Management

Table of Contents

Type-Interface

What is meant by "Type-Interface" is welcome to interpretation. However, the intended definition is as follows:

A primitive data-type, with special utility functions and methods.

Usage

@cloud-technology/parameter uses the latest Node.js LTS version; to quickly enable, run nvm use.

Package ScriptNPM Command InvocationDescription
testnpm testUnit-Test the Distribution
startnpm startCompile + Unit-Test the Distribution
watchnpm run watchUnit-Test Upon File-System Change(s)
buildnpm run buildCompile Distribution Upon File-System Change(s)
compilenpm run compileCompile Distribution
uploadnpm run uploadDeploy Package to NPM Registry

Development

Recommended - Testing Mode

Locally developing with jest file-watchers helps ensure non-breaking change are introduced.

  1. Install Dependencies
    npm install --quiet
  2. Build *.ts File(s), Enabling TSC File-Watching
    npm run build
  3. Open an Additional TTY and Run
    npm run start

Lastly, continue with development.

For alternative build & unit-testing commands, please refer to the commands list.

Common-JS

const Main = async () => {
    const { Parameter } = await import("@cloud-technology/parameter");

    const instance = new Parameter({
        organization: "IBM",
        environment: "Development",
        application: "Storage-Store",
        service: "Authorization-Service",
        identifier: "Credentials"
    });

    console.log(instance);

    console.log(instance.string());

    console.log(instance.string("Directory"));
    console.log(instance.string("Train-Case"));
    console.log(instance.string("Screaming-Train-Case"));
}

( async () => await Main() )();

Modules

import { Parameter } from "@cloud-technology/parameter";

const instance = new Parameter({
    organization: "IBM",
    environment: "Development",
    application: "Storage-Store",
    service: "Authorization-Service",
    identifier: "Credentials"
});

console.log(instance);
console.log(instance.string());

console.log(instance.string("Directory"));
console.log(instance.string("Train-Case"));
console.log(instance.string("Screaming-Train-Case"));

Documentation

Please see documentation for additional information and reference(s).

0.7.141

3 years ago

0.7.142

3 years ago

0.7.139

3 years ago

0.7.138

3 years ago

0.7.137

3 years ago

0.6.136

3 years ago

0.6.135

3 years ago

0.5.131

3 years ago

0.5.129

3 years ago

0.5.128

3 years ago

0.5.127

3 years ago

0.5.126

3 years ago

0.4.125

3 years ago

0.4.124

3 years ago

0.4.123

3 years ago

0.4.122

3 years ago

0.4.119

4 years ago

0.4.118

4 years ago

0.4.117

4 years ago

0.4.116

4 years ago

0.4.115

4 years ago

0.4.114

4 years ago

0.4.113

4 years ago

0.4.112

4 years ago

0.4.109

4 years ago

0.4.108

4 years ago

0.4.107

4 years ago

0.4.106

4 years ago

0.4.105

4 years ago

0.4.104

4 years ago

0.4.103

4 years ago

0.4.101

4 years ago

0.4.98

4 years ago

0.4.97

4 years ago

0.4.96

4 years ago

0.4.95

4 years ago

0.4.94

4 years ago

0.4.93

4 years ago

0.4.92

4 years ago

0.4.91

4 years ago

0.4.89

4 years ago

0.4.88

4 years ago

0.4.86

4 years ago

0.4.85

4 years ago

0.4.84

4 years ago

0.4.83

4 years ago

0.4.82

4 years ago

0.4.81

4 years ago

0.3.79

4 years ago

0.3.78

4 years ago

0.3.77

4 years ago

0.3.76

4 years ago

0.3.75

4 years ago

0.3.74

4 years ago

0.3.73

4 years ago

0.3.72

4 years ago

0.3.71

4 years ago

0.3.69

4 years ago

0.3.68

4 years ago

0.3.67

4 years ago

0.3.66

4 years ago

0.3.65

4 years ago

0.3.64

4 years ago

0.3.63

4 years ago

0.3.61

4 years ago

0.3.59

4 years ago

0.3.58

4 years ago

0.3.57

4 years ago

0.3.56

4 years ago

0.3.55

4 years ago

0.3.54

4 years ago

0.3.51

4 years ago

0.3.50

4 years ago

0.3.49

4 years ago

0.3.48

4 years ago

0.3.46

4 years ago

0.3.45

4 years ago

0.3.44

4 years ago

0.3.43

4 years ago

0.3.42

4 years ago

0.3.41

4 years ago

0.3.39

4 years ago

0.2.38

4 years ago

0.2.37

4 years ago

0.2.36

4 years ago

0.2.34

4 years ago

0.2.32

4 years ago

0.2.31

4 years ago

0.2.30

4 years ago

0.2.29

4 years ago

0.2.27

4 years ago

0.2.26

4 years ago

0.2.24

4 years ago

0.2.23

4 years ago

0.2.22

4 years ago

0.2.21

4 years ago

0.2.20

4 years ago

0.2.19

4 years ago

0.2.18

4 years ago

0.2.17

4 years ago

0.2.16

4 years ago

0.2.15

4 years ago

0.2.14

4 years ago

0.2.13

4 years ago

0.2.12

4 years ago

0.2.11

4 years ago

0.2.10

4 years ago

0.2.9

4 years ago

0.2.8

4 years ago

0.2.7

4 years ago

0.2.6

4 years ago

0.2.4

4 years ago

0.2.3

4 years ago

0.1.1

4 years ago