diff --git a/tests/mocks/data/index.ts b/tests/mocks/data/index.ts index 4683c4f0..5f7d08b4 100644 --- a/tests/mocks/data/index.ts +++ b/tests/mocks/data/index.ts @@ -43,7 +43,7 @@ export interface Data { * ------------------------------------------------------------------------- */ /** - * Mock data + * Mock `Data` * * @return Data */ diff --git a/tests/mocks/isotopes/client/index.ts b/tests/mocks/isotopes/client/index.ts index 48963318..cdf5fa64 100644 --- a/tests/mocks/isotopes/client/index.ts +++ b/tests/mocks/isotopes/client/index.ts @@ -31,7 +31,7 @@ import { flatten } from "isotopes/format" * ------------------------------------------------------------------------- */ /** - * Mock item + * Mock `IsotopeClientItem` * * @template T - Data type * @@ -54,7 +54,7 @@ export function mockIsotopeClientItem( * ------------------------------------------------------------------------- */ /** - * Mock IsotopeClient.create + * Mock `IsotopeClient.create` * * @param promise - Promise returned by client * @@ -68,7 +68,7 @@ function mockIsotopeClientCreate( } /** - * Mock IsotopeClient.create returning with result + * Mock `IsotopeClient.create` returning with result * * @param item - Item * @@ -79,7 +79,7 @@ export function mockIsotopeClientCreateWithSuccess(): jasmine.Spy { } /** - * Mock IsotopeClient.create throwing an error + * Mock `IsotopeClient.create` throwing an error * * @param err - Error to be thrown * @@ -94,7 +94,7 @@ export function mockIsotopeClientCreateWithError( /* ------------------------------------------------------------------------- */ /** - * Mock IsotopeClient.destroy + * Mock `IsotopeClient.destroy` * * @param promise - Promise returned by client * @@ -108,7 +108,7 @@ function mockIsotopeClientDestroy( } /** - * Mock IsotopeClient.destroy returning with result + * Mock `IsotopeClient.destroy` returning with result * * @param item - Item * @@ -119,7 +119,7 @@ export function mockIsotopeClientDestroyWithSuccess(): jasmine.Spy { } /** - * Mock IsotopeClient.destroy throwing an error + * Mock `IsotopeClient.destroy` throwing an error * * @param err - Error to be thrown * @@ -134,7 +134,7 @@ export function mockIsotopeClientDestroyWithError( /* ------------------------------------------------------------------------- */ /** - * Mock IsotopeClient.get + * Mock `IsotopeClient.get` * * @param promise - Promise returned by client * @@ -148,7 +148,7 @@ function mockIsotopeClientGet( } /** - * Mock IsotopeClient.get returning with result + * Mock `IsotopeClient.get` returning with result * * @param item - Item * @@ -161,7 +161,7 @@ export function mockIsotopeClientGetWithResult( } /** - * Mock IsotopeClient.get returning without result + * Mock `IsotopeClient.get` returning without result * * @return Jasmine spy */ @@ -170,7 +170,7 @@ export function mockIsotopeClientGetWithoutResult(): jasmine.Spy { } /** - * Mock IsotopeClient.get throwing an error + * Mock `IsotopeClient.get` throwing an error * * @param err - Error to be thrown * @@ -185,7 +185,7 @@ export function mockIsotopeClientGetWithError( /* ------------------------------------------------------------------------- */ /** - * Mock IsotopeClient.put + * Mock `IsotopeClient.put` * * @param promise - Promise returned by client * @@ -199,7 +199,7 @@ function mockIsotopeClientPut( } /** - * Mock IsotopeClient.put returning with success + * Mock `IsotopeClient.put` returning with success * * @return Jasmine spy */ @@ -208,7 +208,7 @@ export function mockIsotopeClientPutWithSuccess(): jasmine.Spy { } /** - * Mock IsotopeClient.put throwing an error + * Mock `IsotopeClient.put` throwing an error * * @param err - Error to be thrown * @@ -223,7 +223,7 @@ export function mockIsotopeClientPutWithError( /* ------------------------------------------------------------------------- */ /** - * Mock IsotopeClient.delete + * Mock `IsotopeClient.delete` * * @param promise - Promise returned by client * @@ -237,7 +237,7 @@ function mockIsotopeClientDelete( } /** - * Mock IsotopeClient.delete returning with success + * Mock `IsotopeClient.delete` returning with success * * @return Jasmine spy */ @@ -246,7 +246,7 @@ export function mockIsotopeClientDeleteWithSuccess(): jasmine.Spy { } /** - * Mock IsotopeClient.delete throwing an error + * Mock `IsotopeClient.delete` throwing an error * * @param err - Error to be thrown * @@ -261,7 +261,7 @@ export function mockIsotopeClientDeleteWithError( /* ------------------------------------------------------------------------- */ /** - * Mock IsotopeClient.select + * Mock `IsotopeClient.select` * * @param promise - Promise returned by client * @@ -275,7 +275,7 @@ function mockIsotopeClientSelect( } /** - * Mock IsotopeClient.select returning with result + * Mock `IsotopeClient.select` returning with result * * @param list - Item list * @@ -290,7 +290,7 @@ export function mockIsotopeClientSelectWithResult( } /** - * Mock IsotopeClient.select returning without result + * Mock `IsotopeClient.select` returning without result * * @return Jasmine spy */ @@ -301,7 +301,7 @@ export function mockIsotopeClientSelectWithoutResult(): jasmine.Spy { } /** - * Mock IsotopeClient.select throwing an error + * Mock `IsotopeClient.select` throwing an error * * @param err - Error to be thrown * diff --git a/tests/mocks/vendor/aws-sdk/error/index.ts b/tests/mocks/vendor/aws-sdk/error/index.ts index 1b937419..d6c3fa7a 100644 --- a/tests/mocks/vendor/aws-sdk/error/index.ts +++ b/tests/mocks/vendor/aws-sdk/error/index.ts @@ -36,7 +36,7 @@ class AWSMockError extends Error { * ------------------------------------------------------------------------- */ /** - * Mock AWS error + * Mock an AWS error * * @param statusCode - Status code * diff --git a/tests/mocks/vendor/aws-sdk/simpledb/create-domain.ts b/tests/mocks/vendor/aws-sdk/simpledb/create-domain.ts index c4783cfe..337502cd 100644 --- a/tests/mocks/vendor/aws-sdk/simpledb/create-domain.ts +++ b/tests/mocks/vendor/aws-sdk/simpledb/create-domain.ts @@ -28,7 +28,7 @@ import { mock, restore } from "aws-sdk-mock" * ------------------------------------------------------------------------- */ /** - * Mock SimpleDB.createDomain + * Mock `SimpleDB.createDomain` * * @param spy - Spy/fake to mock SimpleDB * @@ -45,7 +45,7 @@ function mockSimpleDBCreateDomain( } /** - * Mock SimpleDB.createDomain returning with success + * Mock `SimpleDB.createDomain` returning with success * * @return Jasmine spy */ @@ -55,7 +55,7 @@ export function mockSimpleDBCreateDomainWithSuccess(): jasmine.Spy { } /** - * Mock SimpleDB.createDomain throwing an error + * Mock `SimpleDB.createDomain` throwing an error * * @param err - Error to be thrown * @@ -70,7 +70,7 @@ export function mockSimpleDBCreateDomainWithError( } /** - * Restore SimpleDB.createDomain + * Restore `SimpleDB.createDomain` */ export function restoreSimpleDBCreateDomain() { restore("SimpleDB", "createDomain") diff --git a/tests/mocks/vendor/aws-sdk/simpledb/delete-attributes.ts b/tests/mocks/vendor/aws-sdk/simpledb/delete-attributes.ts index 507e5e2b..8e45f937 100644 --- a/tests/mocks/vendor/aws-sdk/simpledb/delete-attributes.ts +++ b/tests/mocks/vendor/aws-sdk/simpledb/delete-attributes.ts @@ -28,7 +28,7 @@ import { mock, restore } from "aws-sdk-mock" * ------------------------------------------------------------------------- */ /** - * Mock SimpleDB.deleteAttributes + * Mock `SimpleDB.deleteAttributes` * * @param spy - Spy/fake to mock SimpleDB * @@ -45,7 +45,7 @@ function mockSimpleDBDeleteAttributes( } /** - * Mock SimpleDB.deleteAttributes returning with success + * Mock `SimpleDB.deleteAttributes` returning with success * * @return Jasmine spy */ @@ -55,7 +55,7 @@ export function mockSimpleDBDeleteAttributesWithSuccess(): jasmine.Spy { } /** - * Mock SimpleDB.deleteAttributes throwing an error + * Mock `SimpleDB.deleteAttributes` throwing an error * * @param err - Error to be thrown * @@ -70,7 +70,7 @@ export function mockSimpleDBDeleteAttributesWithError( } /** - * Restore SimpleDB.deleteAttributes + * Restore `SimpleDB.deleteAttributes` */ export function restoreSimpleDBDeleteAttributes() { restore("SimpleDB", "deleteAttributes") diff --git a/tests/mocks/vendor/aws-sdk/simpledb/delete-domain.ts b/tests/mocks/vendor/aws-sdk/simpledb/delete-domain.ts index 85a886c4..9a5466ec 100644 --- a/tests/mocks/vendor/aws-sdk/simpledb/delete-domain.ts +++ b/tests/mocks/vendor/aws-sdk/simpledb/delete-domain.ts @@ -28,7 +28,7 @@ import { mock, restore } from "aws-sdk-mock" * ------------------------------------------------------------------------- */ /** - * Mock SimpleDB.deleteDomain + * Mock `SimpleDB.deleteDomain` * * @param spy - Spy/fake to mock SimpleDB * @@ -45,7 +45,7 @@ function mockSimpleDBDeleteDomain( } /** - * Mock SimpleDB.deleteDomain returning with success + * Mock `SimpleDB.deleteDomain` returning with success * * @return Jasmine spy */ @@ -55,7 +55,7 @@ export function mockSimpleDBDeleteDomainWithSuccess(): jasmine.Spy { } /** - * Mock SimpleDB.deleteDomain throwing an error + * Mock `SimpleDB.deleteDomain` throwing an error * * @param err - Error to be thrown * @@ -70,7 +70,7 @@ export function mockSimpleDBDeleteDomainWithError( } /** - * Restore SimpleDB.deleteDomain + * Restore `SimpleDB.deleteDomain` */ export function restoreSimpleDBDeleteDomain() { restore("SimpleDB", "deleteDomain") diff --git a/tests/mocks/vendor/aws-sdk/simpledb/get-attributes.ts b/tests/mocks/vendor/aws-sdk/simpledb/get-attributes.ts index 9fbc4b42..78c46518 100644 --- a/tests/mocks/vendor/aws-sdk/simpledb/get-attributes.ts +++ b/tests/mocks/vendor/aws-sdk/simpledb/get-attributes.ts @@ -31,7 +31,7 @@ import { IsotopeDictionary } from "isotopes/format" * ------------------------------------------------------------------------- */ /** - * Mock SimpleDB.getAttributes + * Mock `SimpleDB.getAttributes` * * @param spy - Spy/fake to mock SimpleDB * @@ -48,7 +48,7 @@ function mockSimpleDBGetAttributes( } /** - * Mock SimpleDB.getAttributes returning with result + * Mock `SimpleDB.getAttributes` returning with result * * @param attrs - Attributes * @@ -65,7 +65,7 @@ export function mockSimpleDBGetAttributesWithResult( } /** - * Mock SimpleDB.getAttributes returning with result + * Mock `SimpleDB.getAttributes` returning with result * * @return Jasmine spy */ @@ -76,7 +76,7 @@ export function mockSimpleDBGetAttributesWithoutResult(): jasmine.Spy { } /** - * Mock SimpleDB.getAttributes throwing an error + * Mock `SimpleDB.getAttributes` throwing an error * * @param err - Error to be thrown * diff --git a/tests/mocks/vendor/aws-sdk/simpledb/put-attributes.ts b/tests/mocks/vendor/aws-sdk/simpledb/put-attributes.ts index f8409b9f..b134f0f7 100644 --- a/tests/mocks/vendor/aws-sdk/simpledb/put-attributes.ts +++ b/tests/mocks/vendor/aws-sdk/simpledb/put-attributes.ts @@ -28,7 +28,7 @@ import { mock, restore } from "aws-sdk-mock" * ------------------------------------------------------------------------- */ /** - * Mock SimpleDB.putAttributes + * Mock `SimpleDB.putAttributes` * * @param spy - Spy/fake to mock SimpleDB * @@ -45,7 +45,7 @@ function mockSimpleDBPutAttributes( } /** - * Mock SimpleDB.putAttributes returning with success + * Mock `SimpleDB.putAttributes` returning with success * * @return Jasmine spy */ @@ -55,7 +55,7 @@ export function mockSimpleDBPutAttributesWithSuccess(): jasmine.Spy { } /** - * Mock SimpleDB.putAttributes throwing an error + * Mock `SimpleDB.putAttributes` throwing an error * * @param err - Error to be thrown * @@ -70,7 +70,7 @@ export function mockSimpleDBPutAttributesWithError( } /** - * Restore SimpleDB.putAttributes + * Restore `SimpleDB.putAttributes` */ export function restoreSimpleDBPutAttributes() { restore("SimpleDB", "putAttributes") diff --git a/tests/mocks/vendor/aws-sdk/simpledb/select.ts b/tests/mocks/vendor/aws-sdk/simpledb/select.ts index 768eb986..d035a8a8 100644 --- a/tests/mocks/vendor/aws-sdk/simpledb/select.ts +++ b/tests/mocks/vendor/aws-sdk/simpledb/select.ts @@ -33,7 +33,7 @@ import { * ------------------------------------------------------------------------- */ /** - * Mock SimpleDB.select + * Mock `SimpleDB.select` * * @param spy - Spy/fake to mock SimpleDB * @@ -50,7 +50,7 @@ function mockSimpleDBSelect( } /** - * Mock SimpleDB.select returning with result + * Mock `SimpleDB.select` returning with result * * @param items - Items * @param next - Token for pagination @@ -72,7 +72,7 @@ export function mockSimpleDBSelectWithResult( } /** - * Mock SimpleDB.select returning with result + * Mock `SimpleDB.select` returning without result * * @return Jasmine spy */ @@ -83,7 +83,7 @@ export function mockSimpleDBSelectWithoutResult(): jasmine.Spy { } /** - * Mock SimpleDB.select throwing an error + * Mock `SimpleDB.select` throwing an error * * @param err - Error to be thrown * @@ -98,7 +98,7 @@ export function mockSimpleDBSelectWithError( } /** - * Restore SimpleDB.select + * Restore `SimpleDB.select` */ export function restoreSimpleDBSelect() { restore("SimpleDB", "select")