Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbartholomae/raw-data
Data sets for testing with realistic but synthetic data
https://github.com/dbartholomae/raw-data
Last synced: about 1 month ago
JSON representation
Data sets for testing with realistic but synthetic data
- Host: GitHub
- URL: https://github.com/dbartholomae/raw-data
- Owner: dbartholomae
- License: mit
- Created: 2022-01-06T21:09:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-21T08:41:25.000Z (over 1 year ago)
- Last Synced: 2024-10-31T18:55:45.459Z (about 2 months ago)
- Language: TypeScript
- Size: 2.27 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# raw-data
[](https://npmjs.org/package/raw-data)
[](https://npm-stat.com/charts.html?package=raw-data)
[](https://github.com/dbartholomae/raw-data/issues)
[](https://github.com/semantic-release/semantic-release#badge)
[](https://github.com/dbartholomae/raw-data/blob/main/LICENSE)
Raw data for testing with realistic but synthetic data.
## 🛠 Usage
This package just contains data sets, so it can be used with all sorts of
other libraries. The intended usage is with a property-based testing framework
like [fast-check](https://github.com/dubzzz/fast-check), and all advanced
examples in this documentation will use fast-check.
The initial data sets come from faker.js and this project
was inspired by faker.js being abandoned by its creator.
### Basic usage
Import the data set you want to use
```ts
import { firstNames } from 'raw-data';
// ['Alfred', 'Bertram', ...]
```
and create arbitraries from them:
```ts
import { firstNames, lastNames } from "raw-data";
import {
assert,
constantFrom,
emailAddress,
property,
record,
} from "fast-check";
function isValidUser(user: any) {
return (
user != null &&
user.firstName !== undefined &&
user.lastName !== undefined &&
user.email !== undefined
);
}
const arbitraryUser = record({
firstName: constantFrom(...firstNames),
lastName: constantFrom(...lastNames),
email: emailAddress(),
});
describe("isValidUser", () => {
it("accepts a valid user", () => {
assert(
property(arbitraryUser, (user) => {
expect(isValidUser(user)).toBe(true);
})
);
});
});
```
These can then also be used to create example data:
```ts
import { firstNames, lastNames } from "raw-data";
import { constantFrom, emailAddress, record, sample } from "fast-check";
interface User {
firstName: string;
lastName: string;
email: string;
}
const arbitraryUser = record({
firstName: constantFrom(...firstNames),
lastName: constantFrom(...lastNames),
email: emailAddress(),
});
function generateUser(overrides: Partial = {}) {
return { ...sample(arbitraryUser, 1)[0], ...overrides };
}
it("generates a user", () => {
expect(generateUser({ email: "[email protected]" })).toMatchObject({
firstName: expect.any(String),
lastName: expect.any(String),
email: "[email protected]",
});
});
```
### Data lists
The following data lists are currently available:
* firstNames
* lastNames
## 🏠 Homepage
You can find more about this on [https://dbartholomae.github.io/raw-data](https://dbartholomae.github.io/raw-data).
## 🖋️ Contributing
If you are interested in contributing to this repository, please read up on the details in our [contributing guidelines](./CONTRIBUTING.md).
## 🤝 Show your support
Give a ⭐ if this package helped you! You can also support the development of this package by funding.
* [github.com](https://github.com/sponsors/dbartholomae)
## 📜 License
MIT. See [LICENSE file](./LICENSE) for details.
### Copyright notice
Some of the data in this library falls below the following copyright note:
* - Copyright (c) 2007-2010 Benjamin Curtis
* - Copyright 2004-2005 by Jason Kohles