Skip to content

Commit add65de

Browse files
squidfunksquidfunk
committed
Documentation
1 parent b4393b7 commit add65de

File tree

9 files changed

+48
-48
lines changed

9 files changed

+48
-48
lines changed

‎tests/mocks/data/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface Data {
4343
* ------------------------------------------------------------------------- */
4444

4545
/**
46-
* Mock data
46+
* Mock `Data`
4747
*
4848
* @return Data
4949
*/

‎tests/mocks/isotopes/client/index.ts

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import { flatten } from "isotopes/format"
3131
* ------------------------------------------------------------------------- */
3232

3333
/**
34-
* Mock item
34+
* Mock `IsotopeClientItem`
3535
*
3636
* @template T - Data type
3737
*
@@ -54,7 +54,7 @@ export function mockIsotopeClientItem<T>(
5454
* ------------------------------------------------------------------------- */
5555

5656
/**
57-
* Mock IsotopeClient.create
57+
* Mock `IsotopeClient.create`
5858
*
5959
* @param promise - Promise returned by client
6060
*
@@ -68,7 +68,7 @@ function mockIsotopeClientCreate<T>(
6868
}
6969

7070
/**
71-
* Mock IsotopeClient.create returning with result
71+
* Mock `IsotopeClient.create` returning with result
7272
*
7373
* @param item - Item
7474
*
@@ -79,7 +79,7 @@ export function mockIsotopeClientCreateWithSuccess(): jasmine.Spy {
7979
}
8080

8181
/**
82-
* Mock IsotopeClient.create throwing an error
82+
* Mock `IsotopeClient.create` throwing an error
8383
*
8484
* @param err - Error to be thrown
8585
*
@@ -94,7 +94,7 @@ export function mockIsotopeClientCreateWithError(
9494
/* ------------------------------------------------------------------------- */
9595

9696
/**
97-
* Mock IsotopeClient.destroy
97+
* Mock `IsotopeClient.destroy`
9898
*
9999
* @param promise - Promise returned by client
100100
*
@@ -108,7 +108,7 @@ function mockIsotopeClientDestroy<T>(
108108
}
109109

110110
/**
111-
* Mock IsotopeClient.destroy returning with result
111+
* Mock `IsotopeClient.destroy` returning with result
112112
*
113113
* @param item - Item
114114
*
@@ -119,7 +119,7 @@ export function mockIsotopeClientDestroyWithSuccess(): jasmine.Spy {
119119
}
120120

121121
/**
122-
* Mock IsotopeClient.destroy throwing an error
122+
* Mock `IsotopeClient.destroy` throwing an error
123123
*
124124
* @param err - Error to be thrown
125125
*
@@ -134,7 +134,7 @@ export function mockIsotopeClientDestroyWithError(
134134
/* ------------------------------------------------------------------------- */
135135

136136
/**
137-
* Mock IsotopeClient.get
137+
* Mock `IsotopeClient.get`
138138
*
139139
* @param promise - Promise returned by client
140140
*
@@ -148,7 +148,7 @@ function mockIsotopeClientGet<T>(
148148
}
149149

150150
/**
151-
* Mock IsotopeClient.get returning with result
151+
* Mock `IsotopeClient.get` returning with result
152152
*
153153
* @param item - Item
154154
*
@@ -161,7 +161,7 @@ export function mockIsotopeClientGetWithResult(
161161
}
162162

163163
/**
164-
* Mock IsotopeClient.get returning without result
164+
* Mock `IsotopeClient.get` returning without result
165165
*
166166
* @return Jasmine spy
167167
*/
@@ -170,7 +170,7 @@ export function mockIsotopeClientGetWithoutResult(): jasmine.Spy {
170170
}
171171

172172
/**
173-
* Mock IsotopeClient.get throwing an error
173+
* Mock `IsotopeClient.get` throwing an error
174174
*
175175
* @param err - Error to be thrown
176176
*
@@ -185,7 +185,7 @@ export function mockIsotopeClientGetWithError(
185185
/* ------------------------------------------------------------------------- */
186186

187187
/**
188-
* Mock IsotopeClient.put
188+
* Mock `IsotopeClient.put`
189189
*
190190
* @param promise - Promise returned by client
191191
*
@@ -199,7 +199,7 @@ function mockIsotopeClientPut<T>(
199199
}
200200

201201
/**
202-
* Mock IsotopeClient.put returning with success
202+
* Mock `IsotopeClient.put` returning with success
203203
*
204204
* @return Jasmine spy
205205
*/
@@ -208,7 +208,7 @@ export function mockIsotopeClientPutWithSuccess(): jasmine.Spy {
208208
}
209209

210210
/**
211-
* Mock IsotopeClient.put throwing an error
211+
* Mock `IsotopeClient.put` throwing an error
212212
*
213213
* @param err - Error to be thrown
214214
*
@@ -223,7 +223,7 @@ export function mockIsotopeClientPutWithError(
223223
/* ------------------------------------------------------------------------- */
224224

225225
/**
226-
* Mock IsotopeClient.delete
226+
* Mock `IsotopeClient.delete`
227227
*
228228
* @param promise - Promise returned by client
229229
*
@@ -237,7 +237,7 @@ function mockIsotopeClientDelete<T>(
237237
}
238238

239239
/**
240-
* Mock IsotopeClient.delete returning with success
240+
* Mock `IsotopeClient.delete` returning with success
241241
*
242242
* @return Jasmine spy
243243
*/
@@ -246,7 +246,7 @@ export function mockIsotopeClientDeleteWithSuccess(): jasmine.Spy {
246246
}
247247

248248
/**
249-
* Mock IsotopeClient.delete throwing an error
249+
* Mock `IsotopeClient.delete` throwing an error
250250
*
251251
* @param err - Error to be thrown
252252
*
@@ -261,7 +261,7 @@ export function mockIsotopeClientDeleteWithError(
261261
/* ------------------------------------------------------------------------- */
262262

263263
/**
264-
* Mock IsotopeClient.select
264+
* Mock `IsotopeClient.select`
265265
*
266266
* @param promise - Promise returned by client
267267
*
@@ -275,7 +275,7 @@ function mockIsotopeClientSelect<T>(
275275
}
276276

277277
/**
278-
* Mock IsotopeClient.select returning with result
278+
* Mock `IsotopeClient.select` returning with result
279279
*
280280
* @param list - Item list
281281
*
@@ -290,7 +290,7 @@ export function mockIsotopeClientSelectWithResult(
290290
}
291291

292292
/**
293-
* Mock IsotopeClient.select returning without result
293+
* Mock `IsotopeClient.select` returning without result
294294
*
295295
* @return Jasmine spy
296296
*/
@@ -301,7 +301,7 @@ export function mockIsotopeClientSelectWithoutResult(): jasmine.Spy {
301301
}
302302

303303
/**
304-
* Mock IsotopeClient.select throwing an error
304+
* Mock `IsotopeClient.select` throwing an error
305305
*
306306
* @param err - Error to be thrown
307307
*

‎tests/mocks/vendor/aws-sdk/error/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class AWSMockError extends Error {
3636
* ------------------------------------------------------------------------- */
3737

3838
/**
39-
* Mock AWS error
39+
* Mock an AWS error
4040
*
4141
* @param statusCode - Status code
4242
*

‎tests/mocks/vendor/aws-sdk/simpledb/create-domain.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { mock, restore } from "aws-sdk-mock"
2828
* ------------------------------------------------------------------------- */
2929

3030
/**
31-
* Mock SimpleDB.createDomain
31+
* Mock `SimpleDB.createDomain`
3232
*
3333
* @param spy - Spy/fake to mock SimpleDB
3434
*
@@ -45,7 +45,7 @@ function mockSimpleDBCreateDomain(
4545
}
4646

4747
/**
48-
* Mock SimpleDB.createDomain returning with success
48+
* Mock `SimpleDB.createDomain` returning with success
4949
*
5050
* @return Jasmine spy
5151
*/
@@ -55,7 +55,7 @@ export function mockSimpleDBCreateDomainWithSuccess(): jasmine.Spy {
5555
}
5656

5757
/**
58-
* Mock SimpleDB.createDomain throwing an error
58+
* Mock `SimpleDB.createDomain` throwing an error
5959
*
6060
* @param err - Error to be thrown
6161
*
@@ -70,7 +70,7 @@ export function mockSimpleDBCreateDomainWithError(
7070
}
7171

7272
/**
73-
* Restore SimpleDB.createDomain
73+
* Restore `SimpleDB.createDomain`
7474
*/
7575
export function restoreSimpleDBCreateDomain() {
7676
restore("SimpleDB", "createDomain")

‎tests/mocks/vendor/aws-sdk/simpledb/delete-attributes.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { mock, restore } from "aws-sdk-mock"
2828
* ------------------------------------------------------------------------- */
2929

3030
/**
31-
* Mock SimpleDB.deleteAttributes
31+
* Mock `SimpleDB.deleteAttributes`
3232
*
3333
* @param spy - Spy/fake to mock SimpleDB
3434
*
@@ -45,7 +45,7 @@ function mockSimpleDBDeleteAttributes(
4545
}
4646

4747
/**
48-
* Mock SimpleDB.deleteAttributes returning with success
48+
* Mock `SimpleDB.deleteAttributes` returning with success
4949
*
5050
* @return Jasmine spy
5151
*/
@@ -55,7 +55,7 @@ export function mockSimpleDBDeleteAttributesWithSuccess(): jasmine.Spy {
5555
}
5656

5757
/**
58-
* Mock SimpleDB.deleteAttributes throwing an error
58+
* Mock `SimpleDB.deleteAttributes` throwing an error
5959
*
6060
* @param err - Error to be thrown
6161
*
@@ -70,7 +70,7 @@ export function mockSimpleDBDeleteAttributesWithError(
7070
}
7171

7272
/**
73-
* Restore SimpleDB.deleteAttributes
73+
* Restore `SimpleDB.deleteAttributes`
7474
*/
7575
export function restoreSimpleDBDeleteAttributes() {
7676
restore("SimpleDB", "deleteAttributes")

‎tests/mocks/vendor/aws-sdk/simpledb/delete-domain.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { mock, restore } from "aws-sdk-mock"
2828
* ------------------------------------------------------------------------- */
2929

3030
/**
31-
* Mock SimpleDB.deleteDomain
31+
* Mock `SimpleDB.deleteDomain`
3232
*
3333
* @param spy - Spy/fake to mock SimpleDB
3434
*
@@ -45,7 +45,7 @@ function mockSimpleDBDeleteDomain(
4545
}
4646

4747
/**
48-
* Mock SimpleDB.deleteDomain returning with success
48+
* Mock `SimpleDB.deleteDomain` returning with success
4949
*
5050
* @return Jasmine spy
5151
*/
@@ -55,7 +55,7 @@ export function mockSimpleDBDeleteDomainWithSuccess(): jasmine.Spy {
5555
}
5656

5757
/**
58-
* Mock SimpleDB.deleteDomain throwing an error
58+
* Mock `SimpleDB.deleteDomain` throwing an error
5959
*
6060
* @param err - Error to be thrown
6161
*
@@ -70,7 +70,7 @@ export function mockSimpleDBDeleteDomainWithError(
7070
}
7171

7272
/**
73-
* Restore SimpleDB.deleteDomain
73+
* Restore `SimpleDB.deleteDomain`
7474
*/
7575
export function restoreSimpleDBDeleteDomain() {
7676
restore("SimpleDB", "deleteDomain")

‎tests/mocks/vendor/aws-sdk/simpledb/get-attributes.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import { IsotopeDictionary } from "isotopes/format"
3131
* ------------------------------------------------------------------------- */
3232

3333
/**
34-
* Mock SimpleDB.getAttributes
34+
* Mock `SimpleDB.getAttributes`
3535
*
3636
* @param spy - Spy/fake to mock SimpleDB
3737
*
@@ -48,7 +48,7 @@ function mockSimpleDBGetAttributes(
4848
}
4949

5050
/**
51-
* Mock SimpleDB.getAttributes returning with result
51+
* Mock `SimpleDB.getAttributes` returning with result
5252
*
5353
* @param attrs - Attributes
5454
*
@@ -65,7 +65,7 @@ export function mockSimpleDBGetAttributesWithResult(
6565
}
6666

6767
/**
68-
* Mock SimpleDB.getAttributes returning with result
68+
* Mock `SimpleDB.getAttributes` returning with result
6969
*
7070
* @return Jasmine spy
7171
*/
@@ -76,7 +76,7 @@ export function mockSimpleDBGetAttributesWithoutResult(): jasmine.Spy {
7676
}
7777

7878
/**
79-
* Mock SimpleDB.getAttributes throwing an error
79+
* Mock `SimpleDB.getAttributes` throwing an error
8080
*
8181
* @param err - Error to be thrown
8282
*

‎tests/mocks/vendor/aws-sdk/simpledb/put-attributes.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { mock, restore } from "aws-sdk-mock"
2828
* ------------------------------------------------------------------------- */
2929

3030
/**
31-
* Mock SimpleDB.putAttributes
31+
* Mock `SimpleDB.putAttributes`
3232
*
3333
* @param spy - Spy/fake to mock SimpleDB
3434
*
@@ -45,7 +45,7 @@ function mockSimpleDBPutAttributes(
4545
}
4646

4747
/**
48-
* Mock SimpleDB.putAttributes returning with success
48+
* Mock `SimpleDB.putAttributes` returning with success
4949
*
5050
* @return Jasmine spy
5151
*/
@@ -55,7 +55,7 @@ export function mockSimpleDBPutAttributesWithSuccess(): jasmine.Spy {
5555
}
5656

5757
/**
58-
* Mock SimpleDB.putAttributes throwing an error
58+
* Mock `SimpleDB.putAttributes` throwing an error
5959
*
6060
* @param err - Error to be thrown
6161
*
@@ -70,7 +70,7 @@ export function mockSimpleDBPutAttributesWithError(
7070
}
7171

7272
/**
73-
* Restore SimpleDB.putAttributes
73+
* Restore `SimpleDB.putAttributes`
7474
*/
7575
export function restoreSimpleDBPutAttributes() {
7676
restore("SimpleDB", "putAttributes")

0 commit comments

Comments
 (0)