Skip to content

Commit 23f6e6f

Browse files
committed
Update readme and library
1 parent 17b247b commit 23f6e6f

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Generate realistic data through AI and the large amount of data stored in our sy
2020
## Install
2121

2222
```bash
23-
npm install magikfake
23+
npm install magikfake@beta
2424
```
2525

2626
---
@@ -230,8 +230,8 @@ const client = new Client({apiKey: 'your-api-key'});
230230
const query = {
231231
language: Language.en, // required: The values available are: en, it, es, de, fr.
232232
topic: 'user', // required: A casual string that represents the topic
233-
context: Context.library // optional: The business context of your data. It is possible to choose certain values. See Context enum values.
234-
limit: 4 // optional: The number of records to generate.
233+
context: Context.library, // optional: The business context of your data. It is possible to choose certain values. See Context enum values.
234+
limit: 4, // optional: The number of records to generate.
235235
schema: {
236236
id: 'objectId',
237237
name: {
@@ -334,7 +334,7 @@ import {Client, Language, Context }from 'magikfake';
334334

335335
const client = new Client({apiKey: 'your-api-key'});
336336

337-
const fakeData = await client.fakeData.tokenStatus()
337+
const tokenStatus = await client.fakeData.tokenStatus()
338338
```
339339
**Response example**
340340
```json

src/fake-data/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export class FakeData extends Base {
6363
/**
6464
* Token status related to the generation of fake data.
6565
*
66-
* const fakeData = await client.fakeData.tokenStatus()
66+
* const tokenStatus = await client.fakeData.tokenStatus()
6767
*
6868
* @returns {Promise<ITokenStatus>} The promise resolves to an object.
6969
*/

src/index.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { FakeData } from './fake-data';
22
import { Schema } from './schema';
3+
import {Language, Context, SchemaType } from "./types";
34

45
export class Client {
56
fakeData: FakeData;
@@ -14,4 +15,6 @@ export class Client {
1415
this.fakeData = new FakeData(config);
1516
this.schema = new Schema(config);
1617
}
17-
}
18+
}
19+
20+
export { Language, Context, SchemaType };

0 commit comments

Comments
 (0)