Inspectable - Make the output of a class instance in the console meaningful
| 📖 Documentation |
|---|
- Self-Sufficient. The library has zero dependencies (except decorators support).
- Reliable. The library is written in TypeScript and covered by tests.
- Modern. The library comes with native ESM support
Node.js 12.0.0 or newer is required
-
Using
npm(recommended)npm i inspectable
-
Using
Yarnyarn add inspectable
-
Using
pnpmpnpm add inspectable
import { inspectable } from 'inspectable';
class APIRequest {
public method = 'pay';
private token = 'super-private';
}
const request = new APIRequest();
console.log(request);
// APIRequest { method: 'pay', token: 'super-private' }
inspectable(APIRequest, {
serialize(instance) {
return {
method: instance.method
};
}
});
console.log(request);
// APIRequest {
// method: 'pay'
// }import 'reflect-metadata';
import { Inspectable, Inspect } from 'inspectable';
@Inspectable({/* options */})
class APIRequest {
@Inspect()
public method = 'pay';
private token = 'super-private';
@Inspect({ nullable: false })
private signal = null;
@Inspect({ as: 'firstName' })
private name = 'john';
@Inspect({ compute: true })
public canRequest() {
return Boolean(this.token);
}
}
const request = new APIRequest();
console.log(request);
// APIRequest {
// method: 'pay',
// firstName: 'john',
// canRequest: true
// }