Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pstadler/dtox
Extensible data transfer objects in JavaScript.
https://github.com/pstadler/dtox
Last synced: 21 days ago
JSON representation
Extensible data transfer objects in JavaScript.
- Host: GitHub
- URL: https://github.com/pstadler/dtox
- Owner: pstadler
- Created: 2015-09-08T18:18:09.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-19T13:39:26.000Z (about 7 years ago)
- Last Synced: 2024-10-04T16:37:35.485Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/dtox
- Size: 70.3 KB
- Stars: 11
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dtox [](https://travis-ci.org/pstadler/dtox) [](https://coveralls.io/github/pstadler/dtox?branch=master)
Lightweight, extensible data transfer object (DTO) library for Node.js and browser environments.
## Install
```bash
$ npm install dtox --save
```
## Usage
```js
const { BaseDTO, BaseListDTO, fields } = require('dtox')
// Define user mapping
const USER_MAPPING = {
id: fields.number(),
name: fields.string(),
validated: fields.boolean({ default: false }),
roles: fields.list({ default: [], key: 'groups' }),
hasRoles: fields.generic({ callback: (data) => {
return data.groups.length > 0;
}}),
dateCreated: fields.date()
};
// Define a DTO which represents a single user
class UserDTO extends BaseDTO {
constructor(data) {
super(data, USER_MAPPING);
}
}
const user = new UserDTO({
id: 123,
name: 'john_doe',
validated: true,
groups: ['administrator'],
dateCreated: '1997-07-16T19:20:30Z'
});
console.log('Hello ' + user.name); // "Hello john_doe"
console.log('User ' + user.hasRoles ? 'has roles' : 'has no roles'); // "User has roles"
// Define a DTO which represents a list of users
class UserListDTO extends BaseListDTO {
constructor(data) {
super(data, UserDTO);
}
}
const users = new UserListDTO([
{
id: 123,
name: 'john_doe',
groups: ['owner'],
validated: true,
dateCreated: '1997-07-16T19:20:30Z'
},
{
id: 124,
name: 'jane_doe',
groups: ['administrator'],
validated: false,
dateCreated: '2015-12-15T07:36:25Z'
}
]);
const userNames = users.map((user) => {
return user.name;
});
console.log(userNames.join(', ')); // "john_doe, jane_doe"
// or also possible:
for (const userName of users) {
console.log(userName);
}
console.log(JSON.stringify(users)); // will print the items in JSON form
```