Deeperplane Tools - Typescript

This is a collection of tools for working in Typescript.

Installation

``bash
npm install @deeperplane/tools-ts
`

Proxy objects tools

- augmentObject()
- augmentArray()

These functions serve to add additional methods to already existing instances of objects or arrays.
The use of these functions is to convert a generic object instance, as returned by parsing JSON, or communicating
with a server, into an instance of a class that has properties and methods, to make it convenient to work with
in Typescript.

`typescript
import { augmentObject } from '@deeperplane/tools-ts';

const obj = { a: 1, b: 2 };
class MyClass {
a: number = 0;
b: number = 0;
sum() {
return this.a + this.b;
}
}
const myClass = augmentObject(MyClass, obj);

console.log(myClass.sum()); // 3
`

`typescript
import { augmentArray } from '@deeperplane/tools-ts';

const arr = [1, 2, 3];
class MyArray extends Array {
get second() {
return this[1];
}
sum() {
return this.reduce((acc, val) => acc + val, 0);
}
}
const myArray = augmentArray(MyArray, arr);

console.log(myArray.sum()); // 6
console.log(myArray.second); // 2
`

DTO tools

- class DTO

This class is a base class for creating Data Transfer Objects. Currently, it serves more as a documentation tool,
setting a basic framework for creating DTO classes.

`typescript
import { proxyObj, DTO } from '@deeperplane/tools-ts';

class MyDTO extends DTO {
a: number = 0;
b: number = 0;

sum() {
return this.a + this.b;
}

override static isInstance(obj: any): boolean {
return (typeof obj.a === 'number' && typeof obj.b === 'number');
}
constructor(obj: any) {
if (!obj) {
// At least one call to super() is required, so keep this here
super();
return this;
}

if (!MyDTO.isInstance(obj)) {
throw new Error('Invalid data object');
}

return proxyObj.augmentObject(MyDTO, obj) as MyDTO;
}
}

const obj = { a: 1, b: 2 };
const myDTO = new MyDTO(obj);

console.log(myDTO.sum()); // 3
``