19 | 21 | The page you were looking for doesn't exist. 22 |
23 | Go back home 24 |
56 |
57 | 
6 |
7 | Tool for building mocks from typescript's types/interfaces into object
8 | with actual data using Fakerjs
9 |
10 | > Documentation on develop, in the near future I will expose the endpoints for you to use it within your client application, so, stay on tune 🐒
11 |
12 | Table of contents
13 | =================
14 |
15 |
16 | * [Web usage](#web-usage)
17 | * [API usage](#api-documentation)
18 | * [Example as package/library](#Example-as-package/library)
19 | * [FAQs](#faqs)
20 | * [Limitations](#limitations)
21 | * [Status](#status)
22 |
23 |
24 | # Web usage
25 |
26 | Just go to https://butlermock.online/ and in the left panel paste your interfaces or types, just be aware of the [current limitations](#status) ( I am working for supporting the others )
27 |
28 | Wait until the monaco editor shows up and paste your interfaces to later clicking the play button and the mock shows up almost immediately.
29 |
30 | 
31 |
32 | > 
33 |
34 | > The "play" button mocks up, "clipboard" copies the mock created and the "X" button is for cleaning the view
35 |
36 | # API documentation
37 |
38 | Easy peasy
39 |
40 | ``` typescript
41 |
42 | fetch(new URL("/api/mock", 'https://butlermock.online').href, {
43 | method: "POST",
44 | headers: {
45 | "content-type": "application/json",
46 | },
47 | body: JSON.stringify({
48 | value: `interface Test {
49 | Hello: "World!";
50 | }`,
51 | valueForAny: "null", // any parseable json value, values: "null" | "\"Whatever the text you want\"" | "{}" | "0" | "1" | ... | "9"
52 | mustReturn: "", // empty or the top-level name of the interfaces that you provided
53 | quantity: 1, // if is greater than 1, the api response will be an array of the interfaces provided
54 | }),
55 | })
56 | .then(res => res.json()).then(console.log); // should log:
57 | //{
58 | // "Test": {
59 | // "Hello": "World!"
60 | // }
61 | //}
62 |
63 | ```
64 |
65 | > **Always remember to format your interfacer or type correctly, if you forget to add ";" it may result in bad parsing** ;
66 |
67 |
68 | ### Recommedations when using the API
69 |
70 | If you are going to consume the API I suggest that you use fetch() instead of your own HTTPS calling implementation, to avoid sending credentials which I don't store, but security reasons try to use it in the way I suggest, just for privacy reasons. **REPEATING, I DO NOT STORE ANY DATA. :)**.
71 |
72 |
73 | # Example as package/library 👷🏻♂️🚧
74 |
75 | [Check here](https://github.com/Devrax/Butlermock-package) > Under construction 🚧
76 |
77 | # Guide when providing an interface or type to be mocked up
78 |
79 | ```typescript
80 | const mock = new Interface2Mock(`interface Greeting {
81 | hello: string;
82 | cursed: {
83 | damn: string;
84 | }[];
85 | }`); // ❌ Butler mock cannot process direct objects, yet
86 | ```
87 |
88 | ```typescript
89 | const mock = new Interface2Mock(`interface Greeting {
90 | hello: string;
91 | cursed: CursedWord[];
92 | }
93 |
94 | type CursedWord = {
95 | damn: string;
96 | }`); // ✅ Butler Mock can format this way
97 | ```
98 |
99 | # FAQs
100 |
101 | ### **Q: Is it using an AI?**
102 | A: No :)
103 |
104 | ### Q: How can I tell the API or website to give me a fixed value?
105 | A: You just type explicitly the value you want:
106 | ``` typescript
107 | interface ThisIsSparta {
108 | troops: 300;
109 | leader: "Leonidas";
110 | murderedBy: true;
111 | }
112 |
113 | interface mightBeSparta {
114 | troops: 200 | 594 | 2893 | 39;
115 | leader: "Trump" | "Me" | "You?";
116 | murderedBy: true; // fixed Booleans can not be multiples values, for that use explicitly 'boolean'
117 | }
118 | ```
119 |
120 | ### Q: Can I copy full code snippet and it will detect the interfaces?
121 | A: Yes :)
122 | 
123 |
124 | # Limitations
125 |
126 | This section is for known limitations that Butlermocks has, but in the future might be able to recognize and mock:
127 |
128 | |type| casting | description |
129 | |----|---------|-------------|
130 | |Array| Array
239 |