@loopback/docs
Version:
Documentation for LoopBack 4
1,755 lines • 107 kB
JSON
{
"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": "Con