@loopback/docs
Version:
Documentation for LoopBack 4
618 lines (617 loc) • 18 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.3.8",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/repository-tests!",
"docComment": "",
"name": "@loopback/repository-tests",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/repository-tests!",
"name": "",
"members": [
{
"kind": "Interface",
"canonicalReference": "@loopback/repository-tests!CrudFeatures:interface",
"docComment": "/**\n * List of flags describing behavior specific to different connectors and repository implementations. These flags are used by the test suite to tweak assertions and skip tests for scenarios not supported by some implementations.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "CrudFeatures"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "CrudFeatures",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/repository-tests!CrudFeatures#emptyValue:member",
"docComment": "/**\n * The value used by the database to store properties set to `undefined`. Typically, SQL databases store both `undefined` and `null` as `null`.\n *\n * Default: `undefined`\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "emptyValue"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "undefined | null"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "emptyValue",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/repository-tests!CrudFeatures#freeFormProperties:member",
"docComment": "/**\n * Does the database (or the connector) require a fixed schema, or can it support additional (free-form) properties? SQL databases typically don't support free-form properties.\n *\n * Default: `true`\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "freeFormProperties"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "freeFormProperties",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/repository-tests!CrudFeatures#idType:member",
"docComment": "/**\n * What type is used for auto-generated primary keys? - SQL databases typically use auto-incremented numbers, - NoSQL databases tend to use GUID/UUID strings.\n *\n * Default: `'string'`.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "idType"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "'string' | 'number'"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "idType",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/repository-tests!CrudFeatures#supportsTransactions:member",
"docComment": "/**\n * Does the connector support using transactions for performing CRUD operations atomically and being able to commit or rollback the changes? SQL databases usually support transactions\n *\n * Default: `false`\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "supportsTransactions"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "supportsTransactions",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/repository-tests!CrudRepositoryCtor:type",
"docComment": "/**\n * A constructor of a class implementing CrudRepository interface, accepting the Entity class (constructor) and a dataSource instance.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "CrudRepositoryCtor"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "new <"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Entity"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ID"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Relations"
},
{
"kind": "Content",
"text": " extends object>("
},
{
"kind": "Reference",
"text": "entityClass"
},
{
"kind": "Content",
"text": ": typeof "
},
{
"kind": "Reference",
"text": "Entity"
},
{
"kind": "Content",
"text": " & {\n "
},
{
"kind": "Reference",
"text": "prototype"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ";\n}, "
},
{
"kind": "Reference",
"text": "dataSource"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "juggler"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "DataSource"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "EntityCrudRepository"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ID"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Relations"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "CrudRepositoryCtor",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 34
}
},
{
"kind": "Function",
"canonicalReference": "@loopback/repository-tests!crudRepositoryTestSuite:function(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "crudRepositoryTestSuite"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "dataSourceOptions"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "DataSourceOptions"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "repositoryClass"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "CrudRepositoryCtor"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "partialFeatures"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Partial"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "CrudFeatures"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "dataSourceOptions",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "repositoryClass",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
},
{
"parameterName": "partialFeatures",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
}
}
],
"name": "crudRepositoryTestSuite"
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/repository-tests!DataSourceOptions:type",
"docComment": "/**\n * DataSource configuration (connector name, connection string, etc.).\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "DataSourceOptions"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "Options"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "DataSourceOptions",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/repository-tests!TransactionalRepositoryCtor:type",
"docComment": "/**\n * A constructor of a class implementing TransactionalRepository interface, accepting the Entity class (constructor) and a dataSource instance.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type "
},
{
"kind": "Reference",
"text": "TransactionalRepositoryCtor"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "new <"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Entity"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ID"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Relations"
},
{
"kind": "Content",
"text": " extends object>("
},
{
"kind": "Reference",
"text": "entityClass"
},
{
"kind": "Content",
"text": ": typeof "
},
{
"kind": "Reference",
"text": "Entity"
},
{
"kind": "Content",
"text": " & {\n "
},
{
"kind": "Reference",
"text": "prototype"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ";\n}, "
},
{
"kind": "Reference",
"text": "dataSource"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "juggler"
},
{
"kind": "Content",
"text": "."
},
{
"kind": "Reference",
"text": "DataSource"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "TransactionalEntityRepository"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ID"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Relations"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "TransactionalRepositoryCtor",
"typeTokenRange": {
"startIndex": 3,
"endIndex": 34
}
}
]
}
]
}