{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.2.1", "schemaVersion": 1001, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", "canonicalReference": "@loopback/testlab", "docComment": "", "name": "@loopback/testlab", "members": [ { "kind": "EntryPoint", "canonicalReference": "", "name": "", "members": [ { "kind": "Function", "canonicalReference": "(createClientForHandler:0)", "docComment": "/**\n * Create a SuperTest client connected to an HTTP server listening on an ephemeral port and calling `handler` to handle incoming requests.\n *\n * @param - handler\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "createClientForHandler" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "handler" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "req" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "http" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "IncomingMessage" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "res" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "http" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "ServerResponse" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Client" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 19, "endIndex": 20 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "handler", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 18 } } ], "name": "createClientForHandler" }, { "kind": "Function", "canonicalReference": "(createRestAppClient:0)", "docComment": "/**\n * Create a SuperTest client for a running RestApplication instance. It is the responsibility of the caller to ensure that the app is running and to stop the application after all tests are done.\n *\n * @param app - A running (listening) instance of a RestApplication.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "createRestAppClient" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "app" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RestApplicationLike" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "supertest" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "SuperTest" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "supertest" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "Test" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "app", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "createRestAppClient" }, { "kind": "Function", "canonicalReference": "(createStubInstance:0)", "docComment": "/**\n * Creates a new object with the given functions as the prototype and stubs all implemented functions.\n *\n * Note: The given constructor function is not invoked. See also the stub API.\n *\n * This is a helper method replacing `sinon.createStubInstance` and working around the limitations of TypeScript and Sinon, where Sinon is not able to list private/protected members in the type definition of the stub instance and therefore the stub instance cannot be assigned to places expecting TType. See also - https://github.com/Microsoft/TypeScript/issues/13543 - https://github.com/DefinitelyTyped/DefinitelyTyped/issues/14811\n *\n * @param constructor - Object or class to stub.\n *\n * @typeParam TType - Type being stubbed.\n *\n * @returns A stubbed version of the constructor, with an extra property `stubs` providing access to stub API for individual methods.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "createStubInstance" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "constructor" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "sinon" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "StubbableType" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TType" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "StubbedInstanceWithSinonAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TType" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "constructor", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 13 } } ], "typeParameters": [ { "typeParameterName": "TType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createStubInstance" }, { "kind": "Function", "canonicalReference": "(createUnexpectedHttpErrorLogger:0)", "docComment": "/**\n * Creates a Logger that logs an Error if the HTTP status code is not expected\n *\n * @param expectedStatusCode - HTTP status code that is expected\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "createUnexpectedHttpErrorLogger" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "expectedStatusCode" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "LogError" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "expectedStatusCode", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "createUnexpectedHttpErrorLogger" }, { "kind": "Interface", "canonicalReference": "(ExpressContextStub:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ExpressContextStub" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "HandlerContextStub" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ExpressContextStub", "members": [ { "kind": "PropertySignature", "canonicalReference": "app", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "app" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "express" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "Application" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "app", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "request", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "request" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "express" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "Request" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "request", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "response", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "response" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "express" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "Response" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "response", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "result", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "result" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ObservedResponse" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "result", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Function", "canonicalReference": "(givenHttpServerConfig:0)", "docComment": "/**\n * Create an HTTP-server configuration that works well in test environments. - Ask the operating system to assign a free (ephemeral) port. - Use IPv4 localhost `127.0.0.1` to avoid known IPv6 issues in Docker-based environments like Travis-CI. - Provide default TLS key & cert when `protocol` is set to `https`.\n *\n * @param customConfig - Additional configuration options to apply.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "givenHttpServerConfig" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "customConfig" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " & {\n " }, { "kind": "Reference", "text": "protocol" }, { "kind": "Content", "text": "?: string;\n}" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ConfigRetval" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "customConfig", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "givenHttpServerConfig" }, { "kind": "Interface", "canonicalReference": "(HandlerContextStub:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "HandlerContextStub" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "HandlerContextStub", "members": [ { "kind": "PropertySignature", "canonicalReference": "request", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "request" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IncomingMessage" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "request", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "response", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "response" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ServerResponse" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "response", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "result", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "result" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ObservedResponse" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "result", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(httpGetAsync:0)", "docComment": "/**\n * Async wrapper for making HTTP GET requests\n *\n * @param - urlString\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "httpGetAsync" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "urlString" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IncomingMessage" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "urlString", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "httpGetAsync" }, { "kind": "Function", "canonicalReference": "(httpsGetAsync:0)", "docComment": "/**\n * Async wrapper for making HTTPS GET requests\n *\n * @param - urlString\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "httpsGetAsync" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "urlString" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IncomingMessage" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "urlString", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "httpsGetAsync" }, { "kind": "Function", "canonicalReference": "(itSkippedOnTravis:0)", "docComment": "/**\n * Helper function for skipping tests on Travis env - legacy variant supporting `it` only.\n *\n * @deprecated\n *\n * Use `skipOnTravis(it, name, fn)` instead.\n *\n * @param expectation - The test name (the first argument of `it` function).\n *\n * @param callback - The test function (the second argument of `it` function).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "itSkippedOnTravis" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "expectation" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "callback" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "TestFn" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "expectation", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "callback", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "itSkippedOnTravis" }, { "kind": "Interface", "canonicalReference": "(RestApplicationLike:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "RestApplicationLike" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "RestApplicationLike", "members": [ { "kind": "PropertySignature", "canonicalReference": "restServer", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "restServer" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RestServerLike" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "restServer", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(RestServerLike:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "RestServerLike" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "RestServerLike", "members": [ { "kind": "PropertySignature", "canonicalReference": "rootUrl", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "rootUrl" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "rootUrl", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "url", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "url" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "url", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(skipIf:0)", "docComment": "/**\n * Helper function for skipping tests when a certain condition is met.\n *\n * @param skip - Should the test case/suite be skipped?\n *\n * @param verb - The function to invoke to define the test case or the test suite, e.g. `it` or `describe`.\n *\n * @param name - The test name (the first argument of `verb` function).\n *\n * @param args - Additional arguments (framework specific), typically a function implementing the test.\n *\n * @example\n * ```ts\n * skipIf(\n * !connectorFeatures.freeFormProperties,\n * describe,\n * 'free-form properties (strict: false)',\n * () => {\n * // the tests\n * }\n * );\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "skipIf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "skip" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "verb" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TestDefinition" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": "> & {\n " }, { "kind": "Reference", "text": "skip" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TestDefinition" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": ">;\n}" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ..." }, { "kind": "Reference", "text": "args" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 38, "endIndex": 39 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "skip", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "verb", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 29 } }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 32, "endIndex": 33 } }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 36, "endIndex": 37 } } ], "typeParameters": [ { "typeParameterName": "ARGS", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "RETVAL", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "skipIf" }, { "kind": "Function", "canonicalReference": "(skipOnTravis:0)", "docComment": "/**\n * Helper function for skipping tests on Travis CI.\n *\n * @param verb - The function to invoke to define the test case or the test suite, e.g. `it` or `describe`.\n *\n * @param name - The test name (the first argument of `verb` function).\n *\n * @param args - Additional arguments (framework specific), typically a function implementing the test.\n *\n * @example\n * ```ts\n * skipOnTravis(it, 'does something when some condition', async () => {\n * // the test\n * });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "skipOnTravis" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "verb" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TestDefinition" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": "> & {\n " }, { "kind": "Reference", "text": "skip" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TestDefinition" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": ">;\n}" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", ..." }, { "kind": "Reference", "text": "args" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 34, "endIndex": 35 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "verb", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 25 } }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 28, "endIndex": 29 } }, { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 32, "endIndex": 33 } } ], "typeParameters": [ { "typeParameterName": "ARGS", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "RETVAL", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "skipOnTravis" }, { "kind": "Function", "canonicalReference": "(stubExpressContext:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "stubExpressContext" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "requestOptions" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "ShotRequestOptions" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ExpressContextStub" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "stubExpressContext" }, { "kind": "Function", "canonicalReference": "(stubHandlerContext:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "stubHandlerContext" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "requestOptions" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "ShotRequestOptions" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HandlerContextStub" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "requestOptions", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "stubHandlerContext" }, { "kind": "Function", "canonicalReference": "(stubServerRequest:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "stubServerRequest" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ShotRequestOptions" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "IncomingMessage" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "stubServerRequest" }, { "kind": "Function", "canonicalReference": "(stubServerResponse:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "stubServerResponse" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "request" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IncomingMessage" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "onEnd" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ShotCallback" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ServerResponse" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "onEnd", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "stubServerResponse" }, { "kind": "Interface", "canonicalReference": "(TestContext:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "TestContext" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "TestContext", "members": [ { "kind": "IndexSignature", "canonicalReference": "(:index,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "index" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "index", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "MethodSignature", "canonicalReference": "(retries:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "retries" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "n" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "n", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "retries" }, { "kind": "MethodSignature", "canonicalReference": "(skip:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "skip" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "skip" }, { "kind": "MethodSignature", "canonicalReference": "(slow:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "slow" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ms" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ms", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "slow" }, { "kind": "MethodSignature", "canonicalReference": "(timeout:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "timeout" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ms" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number | string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "ms", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "timeout" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(TestFn:interface)", "docComment": "/**\n * * LEGACY API FOR BACKWARDS COMPATIBILITY **\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "TestFn" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "TestFn", "members": [ { "kind": "CallSignature", "canonicalReference": "(:call,1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "this" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TestContext" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PromiseLike" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "this", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "CallSignature", "canonicalReference": "(:call,2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "this" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TestContext" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "done" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "this", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "done", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ] } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(TestSandbox:class)", "docComment": "/**\n * TestSandbox class provides a convenient way to get a reference to a sandbox folder in which you can perform operations for testing purposes.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "TestSandbox" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "TestSandbox", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Will create a directory if it doesn't already exist. If it exists, you still get an instance of the TestSandbox.\n *\n * @param path - Path of the TestSandbox. If relative (it will be resolved relative to cwd()).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "path" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(copyFile:instance,0)", "docComment": "/**\n * Copies a file from src to the TestSandbox. If copying a `.js` file which has an accompanying `.js.map` file in the src file location, the dest file will have its sourceMappingURL updated to point to the original file as an absolute path so you don't need to copy the map file.\n *\n * @param src - Absolute path of file to be copied to the TestSandbox\n *\n * @param dest - Optional. Destination filename of the copy operation (relative to TestSandbox). Original filename used if not specified.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "copyFile" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "src" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "dest" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "src", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "dest", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "copyFile" }, { "kind": "Method", "canonicalReference": "(delete:instance,0)", "docComment": "/**\n * Deletes the TestSandbox.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "delete" }, { "kind": "Method", "canonicalReference": "(getPath:instance,0)", "docComment": "/**\n * Returns the path of the TestSandbox\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "getPath" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "getPath" }, { "kind": "Method", "canonicalReference": "(mkdir:instance,0)", "docComment": "/**\n * Makes a directory in the TestSandbox\n *\n * @param dir - Name of directory to create (relative to TestSandbox path)\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "mkdir" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dir" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dir", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "mkdir" }, { "kind": "Property", "canonicalReference": "(path:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "path" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(reset:instance,0)", "docComment": "/**\n * Resets the TestSandbox. (Remove all files in it).\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "reset" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "reset" } ], "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(toJSON:1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Date" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(toJSON:2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "undefined" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(toJSON:3)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 3, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(toJSON:4)", "docComment": "/**\n * JSON encoding does not preserve properties that are undefined As a result, deepEqual checks fail because the expected model value contains these undefined property values, while the actual result returned by REST API does not. Use this function to convert a model instance into a data object as returned by REST API\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 4, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(toJSON:5)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "undefined" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 5, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(toJSON:6)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "null" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 6, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(toJSON:7)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 7, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(toJSON:8)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 8, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(toJSON:9)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 9, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "toJSON" }, { "kind": "Function", "canonicalReference": "(validateApiSpec:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "validateApiSpec" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "spec" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "spec", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "validateApiSpec" }, { "kind": "TypeAlias", "canonicalReference": "Client", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Client" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "supertest" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "SuperTest" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "supertest" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "Test" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Client", "typeTokenRange": { "startIndex": 3, "endIndex": 11 } }, { "kind": "TypeAlias", "canonicalReference": "ConfigRetval", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "ConfigRetval" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "> = " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " & {\n " }, { "kind": "Reference", "text": "host" }, { "kind": "Content", "text": ": string;\n " }, { "kind": "Reference", "text": "port" }, { "kind": "Content", "text": ": number;\n} & " }, { "kind": "Reference", "text": "HttpsServerOptions" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ConfigRetval", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 7, "endIndex": 14 } }, { "kind": "Variable", "canonicalReference": "expect", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "expect" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Internal" } ], "releaseTag": "Public", "name": "expect", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "Variable", "canonicalReference": "inject", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "inject" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dispatchFunc" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ShotListener" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ShotRequestOptions" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ResponseObject" }, { "kind": "Content", "text": ">" } ], "releaseTag": "Public", "name": "inject", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 15 } }, { "kind": "TypeAlias", "canonicalReference": "ObservedResponse", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "ObservedResponse" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "ResponseObject" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ObservedResponse", "typeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "ShotCallback", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "ShotCallback" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "response" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ResponseObject" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ShotCallback", "typeTokenRange": { "startIndex": 3, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "ShotResponseCtor", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "ShotResponseCtor" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "new (" }, { "kind": "Reference", "text": "request" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IncomingMessage" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "onEnd" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ShotCallback" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "ServerResponse" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ShotResponseCtor", "typeTokenRange": { "startIndex": 3, "endIndex": 13 } }, { "kind": "TypeAlias", "canonicalReference": "StubbedInstanceWithSinonAccessor", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "StubbedInstanceWithSinonAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> = " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " & {\n " }, { "kind": "Reference", "text": "stubs" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "sinon" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "SinonStubbedInstance" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "StubbedInstanceWithSinonAccessor", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 15 } }, { "kind": "TypeAlias", "canonicalReference": "TestDefinition", "docComment": "/**\n * A function defining a new test case or a test suite, e.g. `it` or `describe`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "TestDefinition" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "unknown[]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": string, ..." }, { "kind": "Reference", "text": "args" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ARGS" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "RETVAL" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TestDefinition", "typeParameters": [ { "typeParameterName": "ARGS", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "RETVAL", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 9, "endIndex": 17 } } ] } ] }