# cloud-parameter

> Base Parameter Type-Interface via Node.js

Latest version **0.8.165** (published 2023-02-23) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install cloud-parameter
pnpm add cloud-parameter
yarn add cloud-parameter
bun add cloud-parameter
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.165 |
| Published | 2023-02-23 |
| First published | 2022-06-10 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 153.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jacob B. Sanders |
| Maintainers | segmentational |

## Links

- npm: https://www.npmjs.com/package/cloud-parameter
- Repository: https://github.com/iac-factory/cloud-parameter
- Homepage: https://github.com/iac-factory/cloud-parameter#readme
- Issues: https://github.com/iac-factory/cloud-parameter/issues
- npm.io page: https://npm.io/package/cloud-parameter

## Recent versions

- 0.8.165 (latest) — 2023-02-23
- 0.8.164 — 2023-02-23
- 0.8.163 — 2022-06-16
- 0.8.162 — 2022-06-16
- 0.8.159 — 2022-06-10
- 0.8.158 — 2022-06-10
- 0.8.156 — 2022-06-10
- 0.7.145 — 2022-06-10

## README

# `cloud-parameter` #

[![Socket Badge](https://socket.dev/api/badge/npm/package/cloud-parameter)](https://socket.dev/npm/package/cloud-parameter)


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

`cloud-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.

## Usage ##

`npm install cloud-parameter`

### Common-JS ###

```node
const Main = async () => {
   const {Parameter} = await import("cloud-parameter");

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

/***
 * @example
 * // returns:
 * Parameter {
 *   organization: 'IBM',
 *   environment: 'Development',
 *   application: 'Storage-Store',
 *   service: 'Authorization-Service',
 *   identifier: 'Credentials'
 * };
 *
 * console.log(instance);
 */
console.log(instance);

/***
 * @example
 * // returns IBM/Development/Storage-Store/Authorization-Service/Credentials
 * console.log(instance.string());
 */
console.log(instance.string());

/***
 * @example
 * // returns IBM/Development/Storage-Store/Authorization-Service/Credentials
 * console.log(instance.string("Directory"));
 */
console.log(instance.string("Directory"));

/***
 * @example
 * // returns /IBM/Development/Storage-Store/Authorization-Service/Credentials
 * console.log(instance.string("Directory", true));
 */
console.log(instance.string("Directory", true));

/***
 * @example
 * // returns ibm-development-storage-store-authorization-service-credentials
 * console.log(instance.string("Train-Case"));
 */
console.log(instance.string("Train-Case"));

/***
 * @example
 * // returns Ibm-Development-Storage-Store-Authorization-Service-Credentials
 * console.log(instance.string("Screaming-Train-Case"));
 */
console.log(instance.string("Screaming-Train-Case"));
}

(async () => Main())();
```

### Modules ###

```node
import { Parameter } from "cloud-parameter";

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

/***
 * @example
 * // returns:
 * Parameter {
 *   organization: 'IBM',
 *   environment: 'Development',
 *   application: 'Storage-Store',
 *   service: 'Authorization-Service',
 *   identifier: 'Credentials'
 * };
 *
 * console.log(instance);
 */
console.log(instance);

/***
 * @example
 * // returns IBM/Development/Storage-Store/Authorization-Service/Credentials
 * console.log(instance.string());
 */
console.log(instance.string());

/***
 * @example
 * // returns IBM/Development/Storage-Store/Authorization-Service/Credentials
 * console.log(instance.string("Directory"));
 */
console.log(instance.string("Directory"));

/***
 * @example
 * // returns /IBM/Development/Storage-Store/Authorization-Service/Credentials
 * console.log(instance.string("Directory", true));
 */
console.log(instance.string("Directory", true));

/***
 * @example
 * // returns ibm-development-storage-store-authorization-service-credentials
 * console.log(instance.string("Train-Case"));
 */
console.log(instance.string("Train-Case"));

/***
 * @example
 * // returns Ibm-Development-Storage-Store-Authorization-Service-Credentials
 * console.log(instance.string("Screaming-Train-Case"));
 */
console.log(instance.string("Screaming-Train-Case"));
```

| Package Script | NPM Command Invocation | Description                                        |
|----------------|------------------------|----------------------------------------------------|
| **test**       | `npm test`             | Unit-Test the Distribution                         |
| **update**     | `npm update`           | Compile + Update Unit-Test Snapshot(s)             |
| **start**      | `npm run start`        | Development & Unit-Test Upon File-System Change(s) |
| **build**      | `npm run build`        | Compile Distribution Upon File-System Change(s)    |
| **compile**    | `npm run compile`      | Compile Distribution                               |
| **upload**     | `npm run upload`       | Deploy Package to NPM Registry                     |

### Development ###

**Recommended** - Testing Mode

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

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

Lastly, continue with development.

For alternative build & unit-testing commands, please refer to the [commands list](#usage).

## Documentation ##

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

---
_Source: https://npm.io/package/cloud-parameter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
