@typedly/settings
Version:
A TypeScript type definitions package for settings.
377 lines (282 loc) • 12.1 kB
Markdown
<a href="https://www.typescriptlang.org/">
<img
src="https://avatars.githubusercontent.com/u/189665258?s=400&u=712e292bae048947d1f7d2020d7d38875c40e63a&v=4"
width="20%"
title="@typedly/settings - A collection of TypeScript packages for precise, type-safe development."
/>
</a>
## typedly/settings
<!-- npm badge -->
[![npm version][typedly-npm-badge-svg]][typedly-npm-badge]
[![GitHub issues][typedly-badge-issues]][typedly-issues]
[![GitHub license][typedly-badge-license]][typedly-license]
**Version:** v0.3.0
A **TypeScript** type definitions package for settings.
## Table of contents
- [Installation](#installation)
- [Api](#api)
- [Interface](#interface)
- Other
- [`ValueSetting`](#valuesetting)
- [`Settings`](#settings)
- [Type](#type)
- [`DisplaySelectedSettings`](#displayselectedsettings)
- [`OptionalField`](#optionalfield)
- [`RequiredField`](#requiredfield)
- [`SelectableSettings`](#selectablesettings)
- [Configuration System Overview](#configuration-system-overview)
- [Contributing](#contributing)
- [Support](#support)
- [Code of Conduct](#code-of-conduct)
- [Git](#git)
- [Commit](#commit)
- [Versioning](#versioning)
- [License](#license)
## Installation
### Install peer dependencies
```bash
npm install @typedly/length @typedly/pattern --save-peer
```
### Install the package
```bash
npm install @typedly/settings --save-peer
```
## Api
```typescript
// Interface.
import {
// Value.
ValueSetting,
// Settings.
Settings,
} from '@typedly/settings';
// Type.
import {
// Settings.
DisplaySelectedSettings,
SelectableSettings,
// Settings fields.
OptionalField,
RequiredField,
} from '@typedly/settings';
```
### Interface
#### `ValueSetting`
[`value-setting.interface.ts`](https://github.com/typedly/settings/blob/main/src/interface/value-setting.interface.ts)
```typescript
import { ValueSetting } from '@typedly/settings';
export const valueSettings: ValueSetting<'the value'> = {
value: 'the value'
}
```
#### `Settings`
[`settings.interface.ts`](https://github.com/typedly/settings/blob/main/src/interface/settings.interface.ts)
```typescript
import { Settings } from '@typedly/settings';
export const settings: Settings<
'abcd1234',
number,
27,
34,
RegExp
> = {
// LengthSettings
length: { min: 27, max: 34 },
// PatternSettings
pattern: {
lowercase: true,
numeric: true,
regexp: /[a]g/g,
special: true,
uppercase: true,
},
// ValueSettings
value: 'abcd1234',
}
```
### Type
#### `DisplaySelectedSettings`
[`display-selected-settings.type.ts`](https://github.com/typedly/settings/blob/main/src/type/display-selected-settings.type.ts)
```typescript
import { DisplaySelectedSettings } from '@typedly/settings';
```
#### `OptionalField`
[`optional-field.type.ts`](https://github.com/typedly/settings/blob/main/src/type/optional-field.type.ts)
```typescript
import { OptionalField } from '@typedly/settings';
```
#### `RequiredField`
[`required-field.type.ts`](https://github.com/typedly/settings/blob/main/src/type/required-field.type.ts)
```typescript
import { RequiredField } from '@typedly/settings';
```
#### `SelectableSettings`
[`selectable-settings.type.ts`](https://github.com/typedly/settings/blob/main/src/type/selectable-settings.type.ts)
```typescript
import { SelectableSettings } from '@typedly/settings';
export const settings: SelectableSettings<
['length', 'value'],
'abcd1234',
number,
27,
34,
RegExp
> = {
// LengthSettings
length: { min: 27, max: 34 },
// PatternSettings - not allowed
// pattern: {
// lowercase: true,
// numeric: true,
// regexp: /[a]g/g,
// special: true,
// uppercase: true,
// },
// ValueSettings
value: 'abcd1234',
}
```
## Configuration System Overview
This library uses a structured approach for handling settings, options, and configuration, ensuring strong typing and clarity, as follows.
### Naming Convention for Settings Interfaces
To promote clarity and consistency, the following naming conventions for settings interfaces are used:
- **Singular (`Setting`)**: Represents a single, specific configuration option.
- **Example**:
`LengthSetting` describes the settings for a single aspect, such as the allowed length of a value.
- `MinLengthSetting` describes the minimum length requirement.
- `MaxLengthSetting` describes the maximum length requirement.
- **Plural (`Settings`)**: Represents a group of related settings, often an object containing multiple `Setting` properties.
- **Example**:
`LengthSettings` groups together related settings, such as both minimum and maximum length requirements:
```typescript
export interface LengthSettings {
min: MinLengthSetting;
max: MaxLengthSetting;
}
export interface LengthSetting {
length: LengthSettings;
}
```
#### Summary Table
| Name | Meaning | Example Usage |
|--------------------|----------------------------------------|----------------------------------------------|
| `LengthSetting` | Single setting (e.g., length) | `const min: LengthSetting = { ... }` |
| `MinLengthSetting` | Specific single setting (min length) | `const min: MinLengthSetting = { ... }` |
| `LengthSettings` | Group of related settings (plural) | `const settings: LengthSettings = { ... }` |
### Settings
**Settings** types define the _shape_ of configuration data with all fields **required** at the top level, but can be omitted by setting them to `undefined`.
They represent the complete set of parameters that can be provided, ensuring that all necessary information is present.
The settings may include option objects whose own fields can be optional, even though top-level field in the settings is **required**, but may be set to `undefined`.
- Represents the “full shape” of what can be configured.
- Used for validation, documentation, or generating configuration forms.
- Unlike Options, Settings ensure every possible field is present, event if unset.
_Example:_
```typescript
// Represents the concrete settings for a length configuration.
export interface Length<
Value extends number | undefined = number | undefined,
Min extends number | undefined = number | undefined,
Max extends number | undefined = number | undefined
> {
/**
* @description Represents expected length of the value, also between min and max.
* @type {Value}
*/
value: Value;
/**
* @description Represents the minimum length of the value.
* @type {Min}
*/
min: Min;
/**
* @description Represents the maximum length of the value.
* @type {Max}
*/
max: Max;
}
```
### Options
**Options** types are based on the corresponding settings, but make **all or some fields optional**.
Use options when you want to allow partial configuration, for example for incremental setup or user input that may not specify all values.
_Example:_
```typescript
export interface LengthOptions<
Value extends number | undefined = number | undefined,
Min extends number | undefined = number | undefined,
Max extends number | undefined = number | undefined
> extends OptionalField<Length<Value, Min, Max>> {}
```
---
### Configuration
**Configuration** types represent the _result_ of applying/saving settings and options.
They often reflect the actual configuration that is active at runtime, possibly after defaults and validation have been applied.
_Example:_
```typescript
export type LengthConfiguration = LengthSettings;
```
### **Summary Table**
| Type | Fields Required? | Usage |
|---------------|-------------------|-------------------------------------------|
| Settings | All | Full specification of settings |
| Options | Some/All optional | Partial or user-provided configuration |
| Configuration | All (finalized) | Saved, validated, or runtime configuration|
## Contributing
Your contributions are valued! If you'd like to contribute, please feel free to submit a pull request. Help is always appreciated.
## Support
If you find this package useful and would like to support its and general development, you can contribute through one of the following payment methods. Your support helps maintain the packages and continue adding new.
Support via:
- [Stripe](https://donate.stripe.com/dR614hfDZcJE3wAcMM)
- [Revolut](https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29)
- [GitHub](https://github.com/sponsors/angular-package/sponsorships?sponsor=sciborrudnicki&tier_id=83618)
- [DonorBox](https://donorbox.org/become-a-sponsor-to-the-angular-package?default_interval=o)
- [Patreon](https://www.patreon.com/checkout/angularpackage?rid=0&fan_landing=true&view_as=public)
or via Trust Wallet
- [XLM](https://link.trustwallet.com/send?coin=148&address=GAFFFB7H3LG42O6JA63FJDRK4PP4JCNEOPHLGLLFH625X2KFYQ4UYVM4)
- [USDT (BEP20)](https://link.trustwallet.com/send?coin=20000714&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94&token_id=0x55d398326f99059fF775485246999027B3197955)
- [ETH](https://link.trustwallet.com/send?coin=60&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94)
- [BTC](https://link.trustwallet.com/send?coin=0&address=bc1qnf709336tfl57ta5mfkf4t9fndhx7agxvv9svn)
- [BNB](https://link.trustwallet.com/send?coin=20000714&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94)
Thanks for your support!
## Code of Conduct
By participating in this project, you agree to follow **[Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)**.
## GIT
### Commit
- [AngularJS Git Commit Message Conventions][git-commit-angular]
- [Karma Git Commit Msg][git-commit-karma]
- [Conventional Commits][git-commit-conventional]
### Versioning
[Semantic Versioning 2.0.0][git-semver]
**Given a version number MAJOR.MINOR.PATCH, increment the:**
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
**FAQ**
How should I deal with revisions in the 0.y.z initial development phase?
> The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.
How do I know when to release 1.0.0?
> If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.
## License
MIT © typedly ([license][typedly-license])
<!-- This package: typedly -->
<!-- GitHub: badges -->
[typedly-badge-issues]: https://img.shields.io/github/issues/typedly/settings
[typedly-badge-forks]: https://img.shields.io/github/forks/typedly/settings
[typedly-badge-stars]: https://img.shields.io/github/stars/typedly/settings
[typedly-badge-license]: https://img.shields.io/github/license/typedly/settings
<!-- GitHub: badges links -->
[typedly-issues]: https://github.com/typedly/settings/issues
[typedly-forks]: https://github.com/typedly/settings/network
[typedly-license]: https://github.com/typedly/settings/blob/master/LICENSE
[typedly-stars]: https://github.com/typedly/settings/stargazers
<!-- This package -->
<!-- Package: typedly -->
<!-- npm -->
[typedly-npm-badge-svg]: https://badge.fury.io/js/@typedly%2Fsettings.svg
[typedly-npm-badge]: https://badge.fury.io/js/@typedly%2Fsettings
<!-- GIT -->
[git-semver]: http://semver.org/
<!-- GIT: commit -->
[git-commit-angular]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153
[git-commit-karma]: http://karma-runner.github.io/0.10/dev/git-commit-msg.html
[git-commit-conventional]: https://www.conventionalcommits.org/en/v1.0.0/