UNPKG

@loopback/docs

Version:
1,695 lines (1,694 loc) 1.09 MB
{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.3.8", "schemaVersion": 1003, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", "canonicalReference": "@loopback/repository!", "docComment": "", "name": "@loopback/repository", "members": [ { "kind": "EntryPoint", "canonicalReference": "@loopback/repository!", "name": "", "members": [ { "kind": "Interface", "canonicalReference": "@loopback/repository!AndClause:interface", "docComment": "/**\n * And clause\n *\n * @example\n * ```ts\n * {\n * and: [...],\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "AndClause" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "AndClause", "members": [ { "kind": "PropertySignature", "canonicalReference": "@loopback/repository!AndClause#and:member", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "and" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "and", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "@loopback/repository!ANY:var", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ANY" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AnyType" } ], "releaseTag": "Public", "name": "ANY", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "@loopback/repository!AnyObject:interface", "docComment": "/**\n * Objects with open properties\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "AnyObject", "members": [ { "kind": "IndexSignature", "canonicalReference": "@loopback/repository!AnyObject:index(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "property" }, { "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": 1, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "@loopback/repository!AnyType:class", "docComment": "/**\n * Any type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "AnyType" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "<any> " } ], "releaseTag": "Public", "name": "AnyType", "members": [ { "kind": "Method", "canonicalReference": "@loopback/repository!AnyType#coerce:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "coerce" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "@loopback/repository!AnyType#defaultValue:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "@loopback/repository!AnyType#isCoercible:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "isCoercible" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "@loopback/repository!AnyType#isInstance:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "isInstance" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "@loopback/repository!AnyType#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": " = \"any\";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "@loopback/repository!AnyType#serialize:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "serialize" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "@loopback/repository!ApplicationWithRepositories:interface", "docComment": "/**\n * Interface for an Application mixed in with RepositoryMixin\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ApplicationWithRepositories" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Application" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ApplicationWithRepositories", "members": [ { "kind": "MethodSignature", "canonicalReference": "@loopback/repository!ApplicationWithRepositories#component:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Binding" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "component", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "component" }, { "kind": "MethodSignature", "canonicalReference": "@loopback/repository!ApplicationWithRepositories#dataSource:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "D" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "D" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "D" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Binding" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "D" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 20, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "dataSource", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 15 } }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 18, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "D", "constraintTokenRange": { "startIndex": 4, "endIndex": 7 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "dataSource" }, { "kind": "MethodSignature", "canonicalReference": "@loopback/repository!ApplicationWithRepositories#getRepository:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "getRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "<any>" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "repo" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "repo", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } } ], "typeParameters": [ { "typeParameterName": "R", "constraintTokenRange": { "startIndex": 4, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "getRepository" }, { "kind": "MethodSignature", "canonicalReference": "@loopback/repository!ApplicationWithRepositories#migrateSchema:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "migrateSchema" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "SchemaMigrationOptions" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<void>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "migrateSchema" }, { "kind": "MethodSignature", "canonicalReference": "@loopback/repository!ApplicationWithRepositories#mountComponentRepositories:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "mountComponentRepositories" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<unknown>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "component", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "mountComponentRepositories" }, { "kind": "MethodSignature", "canonicalReference": "@loopback/repository!ApplicationWithRepositories#repository:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "<any>" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "repo" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Binding" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "repo", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "typeParameters": [ { "typeParameterName": "R", "constraintTokenRange": { "startIndex": 4, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "repository" } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "@loopback/repository!ArrayType:class", "docComment": "/**\n * Array type, such as string[]\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ArrayType" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> implements " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "[]> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ArrayType", "members": [ { "kind": "Constructor", "canonicalReference": "@loopback/repository!ArrayType:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `ArrayType` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "itemType" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "itemType", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } } ] }, { "kind": "Method", "canonicalReference": "@loopback/repository!ArrayType#coerce:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "coerce" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "@loopback/repository!ArrayType#defaultValue:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "@loopback/repository!ArrayType#isCoercible:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "isCoercible" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "@loopback/repository!ArrayType#isInstance:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "isInstance" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "@loopback/repository!ArrayType#itemType:member", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "itemType" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "itemType", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "@loopback/repository!ArrayType#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": " = \"array\";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "@loopback/repository!ArrayType#serialize:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "serialize" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "[] | null | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any[] | null | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 5, "endIndex": 9 } ] }, { "kind": "Function", "canonicalReference": "@loopback/repository!belongsTo:function(1)", "docComment": "/**\n * Decorator for belongsTo\n *\n * @param targetResolver - A resolver function that returns the target model for a belongsTo relation\n *\n * @param definition - Optional metadata for setting up a belongsTo relation\n *\n * @param propertyDefinition - Optional metadata for setting up the property\n *\n * @returns A property decorator\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "belongsTo" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "targetResolver" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Partial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "BelongsToDefinition" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, {