https://github.com/automators-com/datamaker-js
The official Node.js / Typescript library for the DataMaker API
https://github.com/automators-com/datamaker-js
data javascript nodejs typescript
Last synced: 9 months ago
JSON representation
The official Node.js / Typescript library for the DataMaker API
- Host: GitHub
- URL: https://github.com/automators-com/datamaker-js
- Owner: automators-com
- License: mit
- Created: 2023-12-08T13:51:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-03T08:03:18.000Z (over 2 years ago)
- Last Synced: 2025-02-09T13:16:11.536Z (over 1 year ago)
- Topics: data, javascript, nodejs, typescript
- Language: TypeScript
- Homepage: https://datamaker.app
- Size: 99.6 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# DataMaker
[](https://opensource.org/licenses/MIT)
## What is it?
The official Node.js / Typescript library for the datamaker API. Datamaker assists with generating realistic relational data for testing and development purposes.
## Installation
```sh
npm install @automators/datamaker
```
## Quick start
Basic example:
```ts
import { DataMaker, Template } from "@automators/datamaker";
const datamaker = new DataMaker({
apiKey: `YOUR_API_KEY`,
});
const generateData = async () => {
const template = {
name: "basic template",
quantity: 2,
fields: [
{
name: "first_name",
type: "First Name",
},
{
name: "last_name",
type: "Last Name",
},
{
name: "email",
type: "Derived",
options: {
value: "{{first_name}}.{{last_name}}@automators.com",
},
},
],
} satisfies Template;
const data = await datamaker.generate(template);
const result = await data.json();
console.log(result);
};
generateData();
```
## Development & Contibutions
See the [contributing.md](/CONTRIBUTING.md) guide for details on how to contribute to this project.
## License
[MIT](https://github.com/automator-com/datamaker-core/blob/main/LICENSE)