UNPKG

@rlaurente/nobe

Version:

NOBackEnd - The next level api mocking library for frontend developers. Data persistent mocking api for MVP apps rapid development.

github.com/rlaurente/nobe.git

rlaurente/nobe.git

129 lines (79 loc) • 3.09 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# @rlaurente/nobe NOBackEnd - The next level api mocking library for frontend developers. Data persistent mocking api for MVP apps rapid development. Demo, Docs will be publish soon ## Install ```bash npm install @rlaurente/nobe ``` ## API <docgen-index> * [`init(...)`](#init) * [`switchBranch(...)`](#switchbranch) * [`get(...)`](#get) * [`set(...)`](#set) * [`request(...)`](#request) * [`mock(...)`](#mock) * [`apply()`](#apply) </docgen-index> <docgen-api> <!--Update the source file JSDoc comments and rerun docgen to update the docs below--> ### init(...) ```typescript init(options: { url: string; workspace?: string; branch?: string; wipe?: boolean; }) => Promise<{ is_success: boolean; }> ``` | Param | Type | | ------------- | ---------------------------------------------------------------------------------- | | **`options`** | <code>{ url: string; workspace?: string; branch?: string; wipe?: boolean; }</code> | **Returns:** <code>Promise&lt;{ is_success: boolean; }&gt;</code> -------------------- ### switchBranch(...) ```typescript switchBranch(options: { branch_name: string; }) => Promise<{ is_success: boolean; }> ``` | Param | Type | | ------------- | ------------------------------------- | | **`options`** | <code>{ branch_name: string; }</code> | **Returns:** <code>Promise&lt;{ is_success: boolean; }&gt;</code> -------------------- ### get(...) ```typescript get(options: { key: string; }) => Promise<any> ``` | Param | Type | | ------------- | ----------------------------- | | **`options`** | <code>{ key: string; }</code> | **Returns:** <code>Promise&lt;any&gt;</code> -------------------- ### set(...) ```typescript set(options: { key: string; data: any; }) => Promise<boolean> ``` | Param | Type | | ------------- | ---------------------------------------- | | **`options`** | <code>{ key: string; data: any; }</code> | **Returns:** <code>Promise&lt;boolean&gt;</code> -------------------- ### request(...) ```typescript request(options: { path: string; type: string; data?: any; headers?: any; }) => Promise<any> ``` | Param | Type | | ------------- | ----------------------------------------------------------------------- | | **`options`** | <code>{ path: string; type: string; data?: any; headers?: any; }</code> | **Returns:** <code>Promise&lt;any&gt;</code> -------------------- ### mock(...) ```typescript mock(options: { path: string; handler: any; }) => void ``` | Param | Type | | ------------- | -------------------------------------------- | | **`options`** | <code>{ path: string; handler: any; }</code> | -------------------- ### apply() ```typescript apply() => Promise<boolean> ``` **Returns:** <code>Promise&lt;boolean&gt;</code> -------------------- </docgen-api>