property-type

Runtime type reflection from TypeScript declaration files for properties.

Installation

``bash
npm install @itrocks/property-type
`

Usage example

File custom-class.ts:
`bash
export class CustomClass {}
`

File demo.ts:
`bash
import { CustomClass } from './custom-class'
import { propertyTypesFromFile } from './property-type'

export class Something {
name = 'a string'
age = 118
birthDay = new Date('1904-12-20')
somethingBig = 154543321452000n
somethingCustom = new CustomClass()
aCollection = new Array()
}

const propertyTypes = propertyTypesFromFile(__dirname + '/demo.js')
Object.entries(propertyTypes).forEach(([property, type]) => {
console.log('-', property, 'type is', type)
})
console.log('is somethingBig a BigInt ?', propertyTypes['somethingBig'] === BigInt)
`

After building and executing the files, the output is:
`
- name is a [Function: String]
- age is a [Function: Number]
- birthDay is a [Function: Date]
- somethingBig is a [Function: BigInt]
- somethingCustom is a [class CustomClass]
- aCollection is a CollectionType {
containerType: [Function: Array],
elementType: [class CustomClass]
}
is name a String ? true
is age a Number ? true
is birthday a Date ? true
is somethingBig a BigInt ? true
is somethingCustom a CustomClass ? true
`

Overview

This library provides utilities to parse TypeScript .d.ts files and extract property types from classes.
It supports both primitive and complex types, including collections, and allows for the mapping of imported types.

Current limitations:

In the current version:
- it works only with .js files that have a corresponding .d.ts TypeScript declaration file in the same location,
- it supports scripts containing a single class only,
aligning with the recommended architecture for it.rocks domain-driven apps,
- it handles relatively simple type expressions, with limited support for complex generics, unions, or intersections,
- the .d.ts file is parsed each time the function is called, which can be slightly slow;
it is up to you to implement caching if needed.
- inherited property types are not parsed; handling inheritance is left to your implementation.

For a more structured approach, consider using the it.rocks
reflection library, @itrocks/reflect,
which leverages propertyTypesFromFile
and additionally handles caching and inheritance.

Functions

$3

`ts
function propertyTypesFromFile(file: string): PropertyTypes
`
Parses a declaration TypeScript file and extracts property types from the defined class.

Parameters:
- file: Absolute path to the .js file. The .d.ts file must be in the same directory.

Returns:
PropertyTypes: A mapping of property names to their types.

$3

`ts
function strToPrimitiveType(type: string): PrimitiveType | Type
`
Converts a string representation of a primitive type
into the corresponding PrimitiveType.

This function only works for JavaScript primitive type strings
and does not handle CollectionType or custom class Type.

Types

$3

`ts
type PrimitiveType = typeof BigInt | Boolean | Number | Object | String | Symbol | undefined
`
Defines the set of supported primitive types.

$3

`ts
type PropertyType = CollectionType | PrimitiveType | Type
`
Represents any single property type, either primitive or complex.

$3

`ts
type PropertyTypes = Record>
`
A mapping of property names to their types.

Classes

$3

`ts
class CollectionType {
constructor(public containerType: Type, public elementType: PrimitiveType | Type)
}
`
An instance of CollectionType represents a property type that contains multiple elements.

Properties:
- collectionType: The type of the collection container, such as
Array,
Map,
or Set.
- elementType`: the type of the elements contained in the collection.