# @wssz/modeler

> Easy expandable lib for decorating object's properties.

Latest version **0.5.5** (published 2020-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wssz/modeler
pnpm add @wssz/modeler
yarn add @wssz/modeler
bun add @wssz/modeler
```

## 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.5.5 |
| Published | 2020-10-10 |
| First published | 2019-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 41.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | wszerad91@gmail.com |
| Maintainers | wszerad |

## Links

- npm: https://www.npmjs.com/package/@wssz/modeler
- Repository: https://github.com/wszerad/wssz-modeler
- Homepage: https://github.com/wszerad/wssz-modeler#readme
- Issues: https://github.com/wszerad/wssz-modeler/issues
- npm.io page: https://npm.io/package/@wssz/modeler

## Dependencies (2)

- [typescript](https://npm.io/package/typescript.md) ^4.0.3
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13

## Recent versions

- 0.5.5 (latest) — 2020-10-10
- 0.5.4 — 2020-05-31
- 0.5.3 — 2020-04-27
- 0.5.2 — 2020-03-31
- 0.5.1 — 2020-03-06
- 0.5.0 — 2020-03-06
- 0.4.0 — 2020-03-06
- 0.3.9 — 2020-02-02
- 0.3.5 — 2020-02-02
- 0.3.4 — 2019-11-27
- 0.3.3 — 2019-11-27
- 0.3.2 — 2019-11-27
- 0.3.1 — 2019-11-15
- 0.3.0 — 2019-11-15
- 0.2.6 — 2019-10-06
- … 11 more at https://npm.io/package/@wssz/modeler/versions

## README

# @wssz/modeler
Easy expandable lib for decorating object's properties.

See my plugins:
* [@wssz/modeler-parser](https://github.com/wszerad/wssz-modeler-parser)
* [@wssz/modeler-jsonschema](https://github.com/wszerad/wssz-modeler-jsonschema)
* [@wssz/modeler-nestjs](https://github.com/wszerad/wssz-modeler-nestjs)

## Usage

* Custom decorator 
```ts
const CustomMarker = defineMarker<String>();
const CustomMarkerWithStaticValue = defineMarker<String>('flag');

class CustomClass {
    @CustomMarker('test')
    @CustomMarkerWithStaticValue()
    p: any;
}

getMarkers(CustomClass)     // class constructor to inspect
    .get('p')               // desired property key
    // data stored of provided decorator
    .get(CustomMarker))     // return 'test'
    // or
    .get(CustomMarkerWithStaticValue))     // return 'flag'
```

## Build-in decorators
* @Prop(type?)
```ts
class Example {
    @Prop()
    simpleType: string;
    
    @Prop(String)
    overwrittenType: any
}

getMarkers(Example).get('simpleType').get(Prop))        // String
getMarkers(Example).get('overwrittenType').get(Prop))   // also String
```

* @Items(type?) and readonly @NestedItems
```ts
class NestedDate extends ArrayItems {
    @Items(Date)
    items: Date[];
}

class Example {
    @Items()
    simpleType: string[];
    
    @Items(Date)
    dataType: Date[];

    @Items(NestedDate)
    nestedType: Date[][];
}

getMarkers(Example).get('simpleType').get(Items)         // true (if no type specified)
getMarkers(Example).get('dataType').get(Items)           // Date
getMarkers(Example).get('nestedType').get(NestedItems)   // [Markers for each nested level]
getMarkers(Example).get('nestedType')
    .get(NestedItems)[0].get(Items)                      // Date
```

* @Attach(decorators: Function[])
```ts
class Example {
    @Attach([Prop(), Required()])
    simpleType: string;
}

getMarkers(Example).get('simpleType').get(Prop))        // String
getMarkers(Example).get('simpleType').get(Required))    // true
```

## Methods and build-in decorators

#### defineMarker<OptionsType>(options: OptionsType): Decorator
* create new decorator

#### getMarkers(classConstructor | className): Map<propKey, Map<Decorator, [OptionsType]>>
* return data stored in class

#### hasMarkers(classConstructor | className):Boolean
* return true if there are data stored in class
 
#### extractDecoratorMarkers(markers: Map<Decorator, [OptionsType]>, decorator: Function, defaultValue?: any)
* return data for given decorator or defaultValue
 
#### Decorators
```ts
export enum Formats {
	Date = 'date',
	Time = 'time',
	DateTime = 'date-time',
	URI = 'uri',
	Email = 'email',
	Hostname = 'hostname',
	IPv4 = 'ipv4',
	IPv6 = 'ipv6',
	Regex = 'regex'
}

type ExamplesType = {[key: string]: {value: any}};
type BasicType = string | number | boolean | RegExp | Object;
type BasicFunction = () => BasicType;

Required<boolean = true>
Minimum<number>
Maximum<number>
ExclusiveMinimum<number>
ExclusiveMaximum<number>
MultipleOf<number>
MaxLength<number>
MinLength<number>
Format<Formats>
Pattern<RegExp>
Enum<Object | (string | number)[]>
MaxItems<number>
MinItems<number>
Default<BasicType | BasicType[] | BasicFunction>
Example<BasicType>
UniqueItems<boolean = true>
Examples<ExamplesType>
Description<string>
Nullable<boolean = true>
```

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