{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.2.1", "schemaVersion": 1001, "oldestForwardsCompatibleVersion": 1001 }, "kind": "Package", "canonicalReference": "@loopback/repository", "docComment": "", "name": "@loopback/repository", "members": [ { "kind": "EntryPoint", "canonicalReference": "", "name": "", "members": [ { "kind": "Interface", "canonicalReference": "(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": "and", "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": "Interface", "canonicalReference": "(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": "(:index,0)", "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": 0, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(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": " " } ], "releaseTag": "Public", "name": "AnyType", "members": [ { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "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": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(name:instance)", "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": "(serialize:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "(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": "(component:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "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": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "component", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "component" }, { "kind": "MethodSignature", "canonicalReference": "(dataSource:0)", "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": 0, "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": "(getRepository:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "getRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "" }, { "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": 0, "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": "(migrateSchema:0)", "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": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "migrateSchema" }, { "kind": "MethodSignature", "canonicalReference": "(mountComponentRepositories:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "mountComponentRepositories" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "component", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "mountComponentRepositories" }, { "kind": "MethodSignature", "canonicalReference": "(repository:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "" }, { "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": 0, "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": "(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": "(:constructor,0)", "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": 0, "parameters": [ { "parameterName": "itemType", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } } ] }, { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "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": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(itemType:instance)", "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": "(name:instance)", "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": "(serialize:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 5, "endIndex": 9 } ] }, { "kind": "Function", "canonicalReference": "(belongsTo:0)", "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": ", " }, { "kind": "Reference", "text": "propertyDefinition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Partial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "decoratedTarget" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "decoratedKey" }, { "kind": "Content", "text": ": string) => void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 28, "endIndex": 35 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "targetResolver", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } }, { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 20 } }, { "parameterName": "propertyDefinition", "parameterTypeTokenRange": { "startIndex": 23, "endIndex": 27 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "belongsTo" }, { "kind": "Interface", "canonicalReference": "(BelongsToDefinition:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "BelongsToDefinition" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "RelationDefinitionBase" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BelongsToDefinition", "members": [ { "kind": "PropertySignature", "canonicalReference": "keyFrom", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "keyFrom" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "keyFrom", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "keyTo", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "keyTo" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "keyTo", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "targetsMany", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "targetsMany" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "false" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "targetsMany", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "type", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RelationType" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "belongsTo" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "(BelongsToRepository:interface)", "docComment": "/**\n * CRUD operations for a target repository of a BelongsTo relation\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "BelongsToRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "BelongsToRepository", "members": [ { "kind": "MethodSignature", "canonicalReference": "(get:0)", "docComment": "/**\n * Gets the target model instance\n *\n * @param - options\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "get" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "get" } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(bindModel:0)", "docComment": "/**\n * This is a bridge to the legacy DAO class. The function mixes DAO methods into a model class and attach it to a given data source\n *\n * @param modelClass - Model class\n *\n * @param ds - Data source\n *\n * @returns {} The new model class with DAO (CRUD) operations\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "bindModel" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "ModelBaseClass" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ds" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 19, "endIndex": 20 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "ds", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 18 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "bindModel" }, { "kind": "Class", "canonicalReference": "(BooleanType:class)", "docComment": "/**\n * Boolean type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "BooleanType" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "BooleanType", "members": [ { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": " = \"boolean\";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(serialize:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "serialize" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "boolean | null | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean | null | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "(BufferType:class)", "docComment": "/**\n * Buffer (binary) type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "BufferType" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Buffer" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "name": "BufferType", "members": [ { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "coerce" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Buffer" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": " = \"buffer\";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(serialize:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "serialize" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Buffer" }, { "kind": "Content", "text": " | null | undefined" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | null | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 7 } ] }, { "kind": "Function", "canonicalReference": "(buildModelDefinition:0)", "docComment": "/**\n * Build model definition from decorations\n *\n * @param target - Target model class\n *\n * @param def - Model definition spec\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "buildModelDefinition" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "target" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": " & {\n " }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "ModelDefinition" }, { "kind": "Content", "text": " | undefined;\n}" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "def" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "ModelDefinitionSyntax" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ModelDefinition" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 16, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 11 } }, { "parameterName": "def", "parameterTypeTokenRange": { "startIndex": 14, "endIndex": 15 } } ], "name": "buildModelDefinition" }, { "kind": "Interface", "canonicalReference": "(Class:interface)", "docComment": "/**\n * Interface for classes with `new` operator and static properties/methods\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Class" }, { "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": "Class", "members": [ { "kind": "IndexSignature", "canonicalReference": "(:index,0)", "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": 0, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "ConstructSignature", "canonicalReference": "(:new,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "new (..." }, { "kind": "Reference", "text": "args" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(Connector:interface)", "docComment": "/**\n * Common properties/operations for connectors\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Connector" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Connector", "members": [ { "kind": "MethodSignature", "canonicalReference": "(connect:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "connect" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "connect" }, { "kind": "MethodSignature", "canonicalReference": "(disconnect:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "disconnect" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "disconnect" }, { "kind": "MethodSignature", "canonicalReference": "(execute:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "execute" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "command" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Command" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "parameters" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "NamedParameters" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "PositionalParameters" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 16, "endIndex": 20 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "parameters", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 11 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 14, "endIndex": 15 } } ], "name": "execute" }, { "kind": "MethodSignature", "canonicalReference": "(ping:0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ping" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "ping" }, { "kind": "PropertySignature", "canonicalReference": "configModel", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "configModel" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "configModel", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "interfaces", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "interfaces" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "interfaces", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "name", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(constrainDataObject:0)", "docComment": "/**\n * A utility function which takes a model instance data and enforces constraint(s) on it\n *\n * @param originalData - the model data to apply the constrain(s) to\n *\n * @param constraint - the constraint which is to be applied on the data object\n *\n * @returns the modified data with the constraint, otherwise the original instance data\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "constrainDataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "originalData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 25 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "originalData", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } }, { "parameterName": "constraint", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 20 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "constrainDataObject" }, { "kind": "Function", "canonicalReference": "(constrainDataObjects:0)", "docComment": "/**\n * A utility function which takes an array of model instance data and enforces constraint(s) on it\n *\n * @param originalData - the array of model data to apply the constrain(s) to\n *\n * @param constraint - the constraint which is to be applied on the data objects\n *\n * @returns an array of the modified data with the constraint, otherwise the original instance data array\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "constrainDataObjects" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "originalData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">[]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">[]" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 25 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "originalData", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } }, { "parameterName": "constraint", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 20 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "constrainDataObjects" }, { "kind": "Function", "canonicalReference": "(constrainFilter:0)", "docComment": "/**\n * A utility function which takes a filter and enforces constraint(s) on it\n *\n * @param originalFilter - the filter to apply the constrain(s) to\n *\n * @param constraint - the constraint which is to be applied on the filter\n *\n * @returns Filter the modified filter with the constraint, otherwise the original filter\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "constrainFilter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "originalFilter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> | undefined" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "originalFilter", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } }, { "parameterName": "constraint", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "constrainFilter" }, { "kind": "Function", "canonicalReference": "(constrainWhere:0)", "docComment": "/**\n * A utility function which takes a where filter and enforces constraint(s) on it\n *\n * @param originalWhere - the where filter to apply the constrain(s) to\n *\n * @param constraint - the constraint which is to be applied on the filter\n *\n * @returns Filter the modified filter with the constraint, otherwise the original filter\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "constrainWhere" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "originalWhere" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> | undefined" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 25 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "originalWhere", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } }, { "parameterName": "constraint", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 20 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "constrainWhere" }, { "kind": "Interface", "canonicalReference": "(ConstructorFunction:interface)", "docComment": "/**\n * Interface for constructor functions without `new` operator.\n *\n * @example\n * ```ts\n * function Foo(x) {\n * if (!(this instanceof Foo)) { return new Foo(x); }\n * this.x = x;\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ConstructorFunction" }, { "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": "ConstructorFunction", "members": [ { "kind": "CallSignature", "canonicalReference": "(:call,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "(..." }, { "kind": "Reference", "text": "args" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(Count:interface)", "docComment": "/**\n * Count of Model instances that were successful for methods like `updateAll`, `deleteAll`, etc.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Count", "members": [ { "kind": "PropertySignature", "canonicalReference": "count", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "count" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "count", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(createBelongsToAccessor:0)", "docComment": "/**\n * Enforces a BelongsTo constraint on a repository\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "createBelongsToAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetId" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Source" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "SourceId" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "belongsToMetadata" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BelongsToDefinition" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepoGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetId" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "sourceRepository" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Source" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "SourceId" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BelongsToAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "SourceId" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 39, "endIndex": 45 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "belongsToMetadata", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 } }, { "parameterName": "targetRepoGetter", "parameterTypeTokenRange": { "startIndex": 21, "endIndex": 29 } }, { "parameterName": "sourceRepository", "parameterTypeTokenRange": { "startIndex": 32, "endIndex": 38 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetId", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Source", "constraintTokenRange": { "startIndex": 11, "endIndex": 12 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "SourceId", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createBelongsToAccessor" }, { "kind": "Function", "canonicalReference": "(createHasManyRepositoryFactory:0)", "docComment": "/**\n * Enforces a constraint on a repository based on a relationship contract between models. For example, if a Customer model is related to an Order model via a HasMany relation, then, the relational repository returned by the factory function would be constrained by a Customer model instance's id(s).\n *\n * @param relationMetadata - The relation metadata used to describe the relationship and determine how to apply the constraint.\n *\n * @param targetRepositoryGetter - The repository which represents the target model of a relation attached to a datasource.\n *\n * @returns The factory function which accepts a foreign key value to constrain the given target repository\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "createHasManyRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "relationMetadata" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "HasManyDefinition" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepositoryGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HasManyRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 26, "endIndex": 32 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "relationMetadata", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "targetRepositoryGetter", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 25 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ForeignKeyType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createHasManyRepositoryFactory" }, { "kind": "Function", "canonicalReference": "(createHasOneRepositoryFactory:0)", "docComment": "/**\n * Enforces a constraint on a repository based on a relationship contract between models. For example, if a Customer model is related to an Address model via a HasOne relation, then, the relational repository returned by the factory function would be constrained by a Customer model instance's id(s).\n *\n * @param relationMetadata - The relation metadata used to describe the relationship and determine how to apply the constraint.\n *\n * @param targetRepositoryGetter - The repository which represents the target model of a relation attached to a datasource.\n *\n * @returns The factory function which accepts a foreign key value to constrain the given target repository\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "createHasOneRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "relationMetadata" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "HasOneDefinition" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepositoryGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HasOneRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 26, "endIndex": 32 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "relationMetadata", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "targetRepositoryGetter", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 25 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ForeignKeyType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createHasOneRepositoryFactory" }, { "kind": "Interface", "canonicalReference": "(CrudConnector:interface)", "docComment": "/**\n * CRUD operations for connector implementations\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "CrudConnector" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Connector" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "CrudConnector", "members": [ { "kind": "MethodSignature", "canonicalReference": "(count:0)", "docComment": "/**\n * Count matching entities\n *\n * @param modelClass - The model class\n *\n * @param where - The matching criteria\n *\n * @param options - Options for the operation\n *\n * @returns A promise of number of matching entities\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "count" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 20, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 15 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 18, "endIndex": 19 } } ], "name": "count" }, { "kind": "MethodSignature", "canonicalReference": "(create:0)", "docComment": "/**\n * Create a new entity\n *\n * @param modelClass - The model class\n *\n * @param entity - The entity instance or data\n *\n * @param options - Options for the operation\n *\n * @returns A promise of the entity created\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "create" }, { "kind": "MethodSignature", "canonicalReference": "(createAll:0)", "docComment": "/**\n * Create multiple entities\n *\n * @param modelClass - The model class\n *\n * @param entities - An array of entity instances or data\n *\n * @param options - Options for the operation\n *\n * @returns A promise of an array of entities created\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "createAll" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "entities" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "entities", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 13 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "createAll" }, { "kind": "MethodSignature", "canonicalReference": "(delete:0)", "docComment": "/**\n * Delete an entity\n *\n * @param modelClass - The model class\n *\n * @param entity - The entity instance or data\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entity is deleted, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "delete" }, { "kind": "MethodSignature", "canonicalReference": "(deleteAll:0)", "docComment": "/**\n * Delete matching entities\n *\n * @param modelClass - The model class\n *\n * @param where - The matching criteria\n *\n * @param options - Options for the operation\n *\n * @returns A promise of number of matching entities deleted\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "deleteAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 20, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 15 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 18, "endIndex": 19 } } ], "name": "deleteAll" }, { "kind": "MethodSignature", "canonicalReference": "(deleteById:0)", "docComment": "/**\n * Delete an entity by id\n *\n * @param modelClass - The model class\n *\n * @param id - The entity id value\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entity is deleted for the id, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "deleteById" }, { "kind": "Content", "text": "?<" }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 19, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 10 } }, { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 } } ], "typeParameters": [ { "typeParameterName": "IdType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "deleteById" }, { "kind": "MethodSignature", "canonicalReference": "(exists:0)", "docComment": "/**\n * Check if an entity exists for the id\n *\n * @param modelClass - The model class\n *\n * @param id - The entity id value\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entity exists for the id, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "exists" }, { "kind": "Content", "text": "?<" }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 19, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 10 } }, { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 } } ], "typeParameters": [ { "typeParameterName": "IdType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "exists" }, { "kind": "MethodSignature", "canonicalReference": "(find:0)", "docComment": "/**\n * Find matching entities by the filter\n *\n * @param modelClass - The model class\n *\n * @param filter - The query filter\n *\n * @param options - Options for the operation\n *\n * @returns A promise of an array of entities found for the filter\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "find" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "find" }, { "kind": "MethodSignature", "canonicalReference": "(findById:0)", "docComment": "/**\n * Find an entity by id\n *\n * @param modelClass - The model class\n *\n * @param id - The entity id value\n *\n * @param options - Options for the operation\n *\n * @returns A promise of the entity found for the id\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "findById" }, { "kind": "Content", "text": "?<" }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 19, "endIndex": 23 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 10 } }, { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 } } ], "typeParameters": [ { "typeParameterName": "IdType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "findById" }, { "kind": "MethodSignature", "canonicalReference": "(replaceById:0)", "docComment": "/**\n * Replace an entity by id\n *\n * @param modelClass - The model class\n *\n * @param id - The entity id value\n *\n * @param data - The data attributes to be updated\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entity is replaced for the id, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "replaceById" }, { "kind": "Content", "text": "?<" }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 23, "endIndex": 25 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 10 } }, { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 21, "endIndex": 22 } } ], "typeParameters": [ { "typeParameterName": "IdType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "replaceById" }, { "kind": "MethodSignature", "canonicalReference": "(save:0)", "docComment": "/**\n * Save an entity\n *\n * @param modelClass - The model class\n *\n * @param entity - The entity instance or data\n *\n * @param options - Options for the operation\n *\n * @returns A promise of the entity saved\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "save" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "save" }, { "kind": "MethodSignature", "canonicalReference": "(update:0)", "docComment": "/**\n * Update an entity\n *\n * @param modelClass - The model class\n *\n * @param entity - The entity instance or data\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entity is updated, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "update" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "(updateAll:0)", "docComment": "/**\n * Update matching entities\n *\n * @param modelClass - The model class\n *\n * @param data - The data attributes to be updated\n *\n * @param where - The matching criteria\n *\n * @param options - Options for the operation\n *\n * @returns A promise of number of matching entities deleted\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "updateAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 24, "endIndex": 28 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 22, "endIndex": 23 } } ], "name": "updateAll" }, { "kind": "MethodSignature", "canonicalReference": "(updateById:0)", "docComment": "/**\n * Update an entity by id\n *\n * @param modelClass - The model class\n *\n * @param id - The entity id value\n *\n * @param data - The data attributes to be updated\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entity is updated for the id, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "updateById" }, { "kind": "Content", "text": "?<" }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "IdType" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 23, "endIndex": 25 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 10 } }, { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 18 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 21, "endIndex": 22 } } ], "typeParameters": [ { "typeParameterName": "IdType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "updateById" } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "(CrudRepository:interface)", "docComment": "/**\n * Basic CRUD operations for ValueObject and Entity. No ID is required.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "CrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "ValueObject" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Relations" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Content", "text": "{}" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Relations", "constraintTokenRange": { "startIndex": 11, "endIndex": 12 }, "defaultTypeTokenRange": { "startIndex": 13, "endIndex": 14 } } ], "name": "CrudRepository", "members": [ { "kind": "MethodSignature", "canonicalReference": "(count:0)", "docComment": "/**\n * Count matching records\n *\n * @param where - Matching criteria\n *\n * @param options - Options for the operations\n *\n * @returns A promise of number of records matched\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "count" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "count" }, { "kind": "MethodSignature", "canonicalReference": "(create:0)", "docComment": "/**\n * Create a new record\n *\n * @param dataObject - The data to be created\n *\n * @param options - Options for the operations\n *\n * @returns A promise of record created\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dataObject" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataObject", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "create" }, { "kind": "MethodSignature", "canonicalReference": "(createAll:0)", "docComment": "/**\n * Create all records\n *\n * @param dataObjects - An array of data to be created\n *\n * @param options - Options for the operations\n *\n * @returns A promise of an array of records created\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "createAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dataObjects" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">[]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataObjects", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "createAll" }, { "kind": "MethodSignature", "canonicalReference": "(deleteAll:0)", "docComment": "/**\n * Delete matching records\n *\n * @param where - Matching criteria\n *\n * @param options - Options for the operations\n *\n * @returns A promise of number of records deleted\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "deleteAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "deleteAll" }, { "kind": "MethodSignature", "canonicalReference": "(find:0)", "docComment": "/**\n * Find matching records\n *\n * @param filter - Query filter\n *\n * @param options - Options for the operations\n *\n * @returns A promise of an array of records found\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "find" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<(" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "Relations" }, { "kind": "Content", "text": ")[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "find" }, { "kind": "MethodSignature", "canonicalReference": "(updateAll:0)", "docComment": "/**\n * Updating matching records with attributes from the data object\n *\n * @param dataObject - The data to be updated\n *\n * @param where - Matching criteria\n *\n * @param options - Options for the operations\n *\n * @returns A promise of number of records updated\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "updateAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dataObject" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 20, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataObject", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 15 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 18, "endIndex": 19 } } ], "name": "updateAll" } ], "extendsTokenRanges": [ { "startIndex": 15, "endIndex": 19 } ] }, { "kind": "Class", "canonicalReference": "(CrudRepositoryImpl:class)", "docComment": "/**\n * Repository implementation\n *\n * @example\n *\n * User can import `CrudRepositoryImpl` and call its functions like: `CrudRepositoryImpl.find(somefilters, someoptions)`\n *\n * Or extend class `CrudRepositoryImpl` and override its functions:\n * ```ts\n * export class TestRepository extends CrudRepositoryImpl {\n * constructor(dataSource: DataSource, model: Test) {\n * super(dataSource, Customer);\n * }\n *\n * // Override `deleteAll` to disable the operation\n * deleteAll(where?: Where, options?: Options) {\n * return Promise.reject(new Error('deleteAll is disabled'));\n * }\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "CrudRepositoryImpl" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": "> implements " }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "CrudRepositoryImpl", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `CrudRepositoryImpl` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "entityClass" }, { "kind": "Content", "text": ": " }, { "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": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataSource", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "entityClass", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 14 } } ] }, { "kind": "Method", "canonicalReference": "(count:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "count" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "count" }, { "kind": "Method", "canonicalReference": "(create:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "create" }, { "kind": "Method", "canonicalReference": "(createAll:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "createAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entities" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">[]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entities", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "createAll" }, { "kind": "Property", "canonicalReference": "(dataSource:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "dataSource", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(delete:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "delete" }, { "kind": "Method", "canonicalReference": "(deleteAll:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "deleteAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "deleteAll" }, { "kind": "Method", "canonicalReference": "(deleteById:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "deleteById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "deleteById" }, { "kind": "Property", "canonicalReference": "(entityClass:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "entityClass" }, { "kind": "Content", "text": ": " }, { "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": "Content", "text": ";" } ], "releaseTag": "Public", "name": "entityClass", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 9 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(execute:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "execute" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "command" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Command" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "parameters" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "NamedParameters" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "PositionalParameters" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 16, "endIndex": 20 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "parameters", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 11 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 14, "endIndex": 15 } } ], "name": "execute" }, { "kind": "Method", "canonicalReference": "(exists:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "exists" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "exists" }, { "kind": "Method", "canonicalReference": "(find:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "find" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "find" }, { "kind": "Method", "canonicalReference": "(findById:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "findById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "findById" }, { "kind": "Method", "canonicalReference": "(replaceById:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "replaceById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "replaceById" }, { "kind": "Method", "canonicalReference": "(save:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "save" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "save" }, { "kind": "Method", "canonicalReference": "(update:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "update" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "update" }, { "kind": "Method", "canonicalReference": "(updateAll:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "updateAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 15 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 18, "endIndex": 19 } } ], "name": "updateAll" }, { "kind": "Method", "canonicalReference": "(updateById:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "updateById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "updateById" } ], "implementsTokenRanges": [ { "startIndex": 9, "endIndex": 15 } ] }, { "kind": "Interface", "canonicalReference": "(DataSource:interface)", "docComment": "/**\n * DataSource denotes a configured connector\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "DataSource", "members": [ { "kind": "IndexSignature", "canonicalReference": "(:index,0)", "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": 0, "parameters": [ { "parameterName": "property", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "PropertySignature", "canonicalReference": "connector", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "connector" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Connector" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "connector", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "name", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "settings", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "settings" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "settings", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(DateType:class)", "docComment": "/**\n * Date type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "DateType" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Date" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "name": "DateType", "members": [ { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Date" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": " = \"date\";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(serialize:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "serialize" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Date" }, { "kind": "Content", "text": " | null | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | null | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 7 } ] }, { "kind": "Class", "canonicalReference": "(DefaultBelongsToRepository:class)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "DefaultBelongsToRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetId" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetId" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "> implements " }, { "kind": "Reference", "text": "BelongsToRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TargetEntity", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetId", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetRepository", "constraintTokenRange": { "startIndex": 11, "endIndex": 17 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "DefaultBelongsToRepository", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructor of DefaultBelongsToEntityCrudRepository\n *\n * @param getTargetRepository - the getter of the related target model repository instance\n *\n * @param constraint - the key value pair representing foreign key name to constrain the target repository instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "getTargetRepository" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "getTargetRepository", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "parameterName": "constraint", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 14 } } ] }, { "kind": "Property", "canonicalReference": "(constraint:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "constraint", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(get:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "get" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "get" }, { "kind": "Property", "canonicalReference": "(getTargetRepository:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "getTargetRepository" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "getTargetRepository", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false } ], "implementsTokenRanges": [ { "startIndex": 18, "endIndex": 22 } ] }, { "kind": "Class", "canonicalReference": "(DefaultCrudRepository:class)", "docComment": "/**\n * Default implementation of CRUD repository using legacy juggler model and data source\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "DefaultCrudRepository" }, { "kind": "Content", "text": "<" }, { "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 " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Content", "text": "{}" }, { "kind": "Content", "text": "> implements " }, { "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": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Relations", "constraintTokenRange": { "startIndex": 11, "endIndex": 12 }, "defaultTypeTokenRange": { "startIndex": 13, "endIndex": 14 } } ], "name": "DefaultCrudRepository", "members": [ { "kind": "Method", "canonicalReference": "(_createBelongsToAccessorFor:instance,0)", "docComment": "/**\n * @deprecated\n *\n * Function to create a belongs to accessor\n *\n * Use `this.createBelongsToAccessorFor()` instead\n *\n * @param relationName - Name of the relation defined on the source model\n *\n * @param targetRepo - Target repository instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "_createBelongsToAccessorFor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetId" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "relationName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepoGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetId" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BelongsToAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 24, "endIndex": 30 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "relationName", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "targetRepoGetter", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 23 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetId", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "_createBelongsToAccessorFor" }, { "kind": "Method", "canonicalReference": "(_createHasManyRepositoryFactoryFor:instance,0)", "docComment": "/**\n * @deprecated\n *\n * Function to create a constrained relation repository factory\n *\n * Use `this.createHasManyRepositoryFactoryFor()` instead\n *\n * @param relationName - Name of the relation defined on the source model\n *\n * @param targetRepo - Target repository instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "_createHasManyRepositoryFactoryFor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "relationName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepoGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HasManyRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 26, "endIndex": 32 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "relationName", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "targetRepoGetter", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 25 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ForeignKeyType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "_createHasManyRepositoryFactoryFor" }, { "kind": "Method", "canonicalReference": "(_createHasOneRepositoryFactoryFor:instance,0)", "docComment": "/**\n * @deprecated\n *\n * Function to create a constrained hasOne relation repository factory\n *\n * @param relationName - Name of the relation defined on the source model\n *\n * @param targetRepo - Target repository instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "_createHasOneRepositoryFactoryFor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "relationName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepoGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HasOneRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 26, "endIndex": 32 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "relationName", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "targetRepoGetter", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 25 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ForeignKeyType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "_createHasOneRepositoryFactoryFor" }, { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructor of DefaultCrudRepository\n *\n * @param entityClass - Legacy entity class\n *\n * @param dataSource - Legacy data source\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "entityClass" }, { "kind": "Content", "text": ": " }, { "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": "Content", "text": ", " }, { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entityClass", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 } }, { "parameterName": "dataSource", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 16 } } ] }, { "kind": "Method", "canonicalReference": "(count:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "count" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "count" }, { "kind": "Method", "canonicalReference": "(create:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "create" }, { "kind": "Method", "canonicalReference": "(createAll:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "createAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entities" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">[]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entities", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "createAll" }, { "kind": "Method", "canonicalReference": "(createBelongsToAccessorFor:instance,0)", "docComment": "/**\n * Function to create a belongs to accessor\n *\n * @param relationName - Name of the relation defined on the source model\n *\n * @param targetRepo - Target repository instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "createBelongsToAccessorFor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetId" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "relationName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepoGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetId" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "BelongsToAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 24, "endIndex": 30 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "relationName", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "targetRepoGetter", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 23 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetId", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createBelongsToAccessorFor" }, { "kind": "Method", "canonicalReference": "(createHasManyRepositoryFactoryFor:instance,0)", "docComment": "/**\n * Function to create a constrained relation repository factory\n *\n * @param relationName - Name of the relation defined on the source model\n *\n * @param targetRepo - Target repository instance\n *\n * @example\n * ```ts\n * class CustomerRepository extends DefaultCrudRepository<\n * Customer,\n * typeof Customer.prototype.id,\n * CustomerRelations\n * > {\n * public readonly orders: HasManyRepositoryFactory;\n *\n * constructor(\n * protected db: juggler.DataSource,\n * orderRepository: EntityCrudRepository,\n * ) {\n * super(Customer, db);\n * this.orders = this._createHasManyRepositoryFactoryFor(\n * 'orders',\n * orderRepository,\n * );\n * }\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "createHasManyRepositoryFactoryFor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "relationName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepoGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HasManyRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 26, "endIndex": 32 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "relationName", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "targetRepoGetter", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 25 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ForeignKeyType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createHasManyRepositoryFactoryFor" }, { "kind": "Method", "canonicalReference": "(createHasOneRepositoryFactoryFor:instance,0)", "docComment": "/**\n * Function to create a constrained hasOne relation repository factory\n *\n * @param relationName - Name of the relation defined on the source model\n *\n * @param targetRepo - Target repository instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "createHasOneRepositoryFactoryFor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "relationName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "targetRepoGetter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "HasOneRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 26, "endIndex": 32 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "relationName", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } }, { "parameterName": "targetRepoGetter", "parameterTypeTokenRange": { "startIndex": 17, "endIndex": 25 } } ], "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ForeignKeyType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "createHasOneRepositoryFactoryFor" }, { "kind": "Property", "canonicalReference": "(dataSource:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "dataSource", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(delete:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "delete" }, { "kind": "Method", "canonicalReference": "(deleteAll:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "deleteAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "deleteAll" }, { "kind": "Method", "canonicalReference": "(deleteById:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "deleteById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "deleteById" }, { "kind": "Property", "canonicalReference": "(entityClass:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "entityClass" }, { "kind": "Content", "text": ": " }, { "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": "Content", "text": ";" } ], "releaseTag": "Public", "name": "entityClass", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 9 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(execute:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "execute" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "command" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Command" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "parameters" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "NamedParameters" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "PositionalParameters" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 16, "endIndex": 20 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "parameters", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 11 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 14, "endIndex": 15 } } ], "name": "execute" }, { "kind": "Method", "canonicalReference": "(exists:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "exists" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "exists" }, { "kind": "Method", "canonicalReference": "(find:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "find" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<(" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "Relations" }, { "kind": "Content", "text": ")[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "find" }, { "kind": "Method", "canonicalReference": "(findById:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "findById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "Relations" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 23 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "findById" }, { "kind": "Method", "canonicalReference": "(findOne:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "findOne" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " | null>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "findOne" }, { "kind": "Property", "canonicalReference": "(modelClass:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "PersistedModelClass" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "modelClass", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(replaceById:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "replaceById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "replaceById" }, { "kind": "Method", "canonicalReference": "(save:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "save" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "save" }, { "kind": "Method", "canonicalReference": "(toEntities:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "toEntities" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "models" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "PersistedModel" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "models", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } } ], "typeParameters": [ { "typeParameterName": "R", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "toEntities" }, { "kind": "Method", "canonicalReference": "(toEntity:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "toEntity" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "model" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "PersistedModel" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "model", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 12 } } ], "typeParameters": [ { "typeParameterName": "R", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "toEntity" }, { "kind": "Method", "canonicalReference": "(update:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "update" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "update" }, { "kind": "Method", "canonicalReference": "(updateAll:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "updateAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 15 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 18, "endIndex": 19 } } ], "name": "updateAll" }, { "kind": "Method", "canonicalReference": "(updateById:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "updateById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "updateById" } ], "implementsTokenRanges": [ { "startIndex": 15, "endIndex": 23 } ] }, { "kind": "Class", "canonicalReference": "(DefaultHasManyRepository:class)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "DefaultHasManyRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "> implements " }, { "kind": "Reference", "text": "HasManyRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TargetEntity", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetRepository", "constraintTokenRange": { "startIndex": 11, "endIndex": 17 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "DefaultHasManyRepository", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructor of DefaultHasManyEntityCrudRepository\n *\n * @param getTargetRepository - the getter of the related target model repository instance\n *\n * @param constraint - the key value pair representing foreign key name to constrain the target repository instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "getTargetRepository" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "getTargetRepository", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "parameterName": "constraint", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 14 } } ] }, { "kind": "Property", "canonicalReference": "(constraint:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "constraint", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(create:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "targetModelData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "targetModelData", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "create" }, { "kind": "Method", "canonicalReference": "(delete:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "delete" }, { "kind": "Method", "canonicalReference": "(find:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "find" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "find" }, { "kind": "Property", "canonicalReference": "(getTargetRepository:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "getTargetRepository" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "getTargetRepository", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(patch:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "patch" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dataObject" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataObject", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 15 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 18, "endIndex": 19 } } ], "name": "patch" } ], "implementsTokenRanges": [ { "startIndex": 18, "endIndex": 22 } ] }, { "kind": "Class", "canonicalReference": "(DefaultHasOneRepository:class)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "DefaultHasOneRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TargetID" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "> implements " }, { "kind": "Reference", "text": "HasOneRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "TargetEntity", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "TargetRepository", "constraintTokenRange": { "startIndex": 11, "endIndex": 17 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "DefaultHasOneRepository", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructor of DefaultHasOneEntityCrudRepository\n *\n * @param getTargetRepository - the getter of the related target model repository instance\n *\n * @param constraint - the key value pair representing foreign key name to constrain the target repository instance\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "getTargetRepository" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "getTargetRepository", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "parameterName": "constraint", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 14 } } ] }, { "kind": "Property", "canonicalReference": "(constraint:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "constraint", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(create:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "targetModelData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "targetModelData", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "create" }, { "kind": "Method", "canonicalReference": "(delete:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "delete" }, { "kind": "Method", "canonicalReference": "(get:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "get" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Pick" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">, " }, { "kind": "Reference", "text": "Exclude" }, { "kind": "Content", "text": ", 'where'>>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 21, "endIndex": 25 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 16 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 } } ], "name": "get" }, { "kind": "Property", "canonicalReference": "(getTargetRepository:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "getTargetRepository" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Getter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetRepository" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "getTargetRepository", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(patch:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "patch" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dataObject" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "TargetEntity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataObject", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "patch" } ], "implementsTokenRanges": [ { "startIndex": 18, "endIndex": 22 } ] }, { "kind": "Class", "canonicalReference": "(DefaultKeyValueRepository:class)", "docComment": "/**\n * An implementation of KeyValueRepository based on loopback-datasource-juggler\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "DefaultKeyValueRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": "> implements " }, { "kind": "Reference", "text": "KeyValueRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "DefaultKeyValueRepository", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Construct a KeyValueRepository with a legacy DataSource\n *\n * @param ds - Legacy DataSource\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "entityClass" }, { "kind": "Content", "text": ": " }, { "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": "Content", "text": ", " }, { "kind": "Reference", "text": "ds" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entityClass", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 10 } }, { "parameterName": "ds", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 16 } } ] }, { "kind": "Method", "canonicalReference": "(delete:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "delete" }, { "kind": "Method", "canonicalReference": "(deleteAll:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "deleteAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "deleteAll" }, { "kind": "Method", "canonicalReference": "(expire:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "expire" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ttl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "ttl", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "expire" }, { "kind": "Method", "canonicalReference": "(get:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "get" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "get" }, { "kind": "Method", "canonicalReference": "(keys:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "keys" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "KeyValueFilter" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "AsyncIterable" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "keys" }, { "kind": "Property", "canonicalReference": "(kvModelClass:instance)", "docComment": "/**\n * A legacy KeyValueModel class\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "kvModelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "KeyValueModel" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "kvModelClass", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(set:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "set" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "set" }, { "kind": "Method", "canonicalReference": "(toEntity:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected " }, { "kind": "Reference", "text": "toEntity" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "legacy" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "ModelData" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelData", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 8 } } ], "name": "toEntity" }, { "kind": "Method", "canonicalReference": "(ttl:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ttl" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "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": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "ttl" } ], "implementsTokenRanges": [ { "startIndex": 7, "endIndex": 11 } ] }, { "kind": "Function", "canonicalReference": "(embedsMany:0)", "docComment": "/**\n * Decorator for embedsMany\n *\n * @param - definition\n *\n * @returns A property decorator\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "embedsMany" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PropertyDecorator" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "embedsMany" }, { "kind": "Function", "canonicalReference": "(embedsOne:0)", "docComment": "/**\n * Decorator for embedsOne\n *\n * @param - definition\n *\n * @returns A property decorator\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "embedsOne" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PropertyDecorator" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "embedsOne" }, { "kind": "Function", "canonicalReference": "(ensurePromise:0)", "docComment": "/**\n * Ensure the value is a promise\n *\n * @param p - Promise or void\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "ensurePromise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "p" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "legacy" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "PromiseOrVoid" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "p", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 13 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ensurePromise" }, { "kind": "Class", "canonicalReference": "(Entity:class)", "docComment": "/**\n * Base class for entities which have unique ids\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": " " }, { "kind": "Content", "text": "implements " }, { "kind": "Reference", "text": "Persistable" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Entity", "members": [ { "kind": "Method", "canonicalReference": "(buildWhereForId:static,0)", "docComment": "/**\n * Build the where object for the given id\n *\n * @param id - The id value\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "buildWhereForId" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "buildWhereForId" }, { "kind": "Method", "canonicalReference": "(getId:instance,0)", "docComment": "/**\n * Get the identity value. If the identity is a composite key, returns an object.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "getId" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "getId" }, { "kind": "Method", "canonicalReference": "(getIdObject:instance,0)", "docComment": "/**\n * Get the identity as an object, such as `{id: 1}` or `{schoolId: 1, studentId: 2}`\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "getIdObject" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "getIdObject" }, { "kind": "Method", "canonicalReference": "(getIdOf:static,0)", "docComment": "/**\n * Get the identity value for a given entity instance or entity data object.\n *\n * @param entityOrData - The data object for which to determine the identity value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "getIdOf" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entityOrData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entityOrData", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "getIdOf" } ], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "(EntityCrudRepository:interface)", "docComment": "/**\n * CRUD operations for a repository of entities\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "EntityCrudRepository" }, { "kind": "Content", "text": "<" }, { "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 " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Content", "text": "{}" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "EntityRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "CrudRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Relations" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Relations", "constraintTokenRange": { "startIndex": 11, "endIndex": 12 }, "defaultTypeTokenRange": { "startIndex": 13, "endIndex": 14 } } ], "name": "EntityCrudRepository", "members": [ { "kind": "MethodSignature", "canonicalReference": "(delete:0)", "docComment": "/**\n * Delete an entity\n *\n * @param entity - Entity to be deleted\n *\n * @param options - Options for the operations\n *\n * @returns A promise that will be resolve if the operation succeeded or will be rejected if the entity was not found.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "delete" }, { "kind": "MethodSignature", "canonicalReference": "(deleteById:0)", "docComment": "/**\n * Delete an entity by id\n *\n * @param id - Value for the entity id\n *\n * @param options - Options for the operations\n *\n * @returns A promise that will be resolve if the operation succeeded or will be rejected if the entity was not found.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "deleteById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "deleteById" }, { "kind": "MethodSignature", "canonicalReference": "(exists:0)", "docComment": "/**\n * Check if an entity exists for the given id\n *\n * @param id - Value for the entity id\n *\n * @param options - Options for the operations\n *\n * @returns Promise if an entity exists for the id, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "exists" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "exists" }, { "kind": "MethodSignature", "canonicalReference": "(findById:0)", "docComment": "/**\n * Find an entity by id, return a rejected promise if not found.\n *\n * @param id - Value for the entity id\n *\n * @param filter - Additional query options. E.g. `filter.include` configures which related models to fetch as part of the database query (or queries).\n *\n * @param options - Options for the operations\n *\n * @returns A promise of an entity found for the id\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "findById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " & " }, { "kind": "Reference", "text": "Relations" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 23 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "findById" }, { "kind": "MethodSignature", "canonicalReference": "(replaceById:0)", "docComment": "/**\n * Replace an entity by id\n *\n * @param id - Value for the entity id\n *\n * @param data - Data attributes to be replaced\n *\n * @param options - Options for the operations\n *\n * @returns A promise that will be resolve if the operation succeeded or will be rejected if the entity was not found.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "replaceById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "replaceById" }, { "kind": "MethodSignature", "canonicalReference": "(save:0)", "docComment": "/**\n * Save an entity. If no id is present, create a new entity\n *\n * @param entity - Entity to be saved\n *\n * @param options - Options for the operations\n *\n * @returns A promise that will be resolve if the operation succeeded or will be rejected if the entity was not found.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "save" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "save" }, { "kind": "MethodSignature", "canonicalReference": "(update:0)", "docComment": "/**\n * Update an entity\n *\n * @param entity - Entity to be updated\n *\n * @param options - Options for the operations\n *\n * @returns A promise that will be resolve if the operation succeeded or will be rejected if the entity was not found.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "update" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "entity" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "update" }, { "kind": "MethodSignature", "canonicalReference": "(updateById:0)", "docComment": "/**\n * Update an entity by id with property/value pairs in the data object\n *\n * @param id - Value for the entity id\n *\n * @param data - Data attributes to be updated\n *\n * @param options - Options for the operations\n *\n * @returns A promise that will be resolve if the operation succeeded or will be rejected if the entity was not found.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "updateById" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "id", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "updateById" }, { "kind": "PropertySignature", "canonicalReference": "entityClass", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "entityClass" }, { "kind": "Content", "text": ": " }, { "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": "Content", "text": ";" } ], "releaseTag": "Public", "name": "entityClass", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 9 } } ], "extendsTokenRanges": [ { "startIndex": 15, "endIndex": 21 }, { "startIndex": 22, "endIndex": 28 } ] }, { "kind": "Class", "canonicalReference": "(EntityNotFoundError:class)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "EntityNotFoundError" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Props" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Content", "text": "{}" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "Error" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "ID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "Props", "constraintTokenRange": { "startIndex": 7, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "EntityNotFoundError", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `EntityNotFoundError` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "entityOrName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "entityId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "extraProperties" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Props" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "entityOrName", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "parameterName": "entityId", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } }, { "parameterName": "extraProperties", "parameterTypeTokenRange": { "startIndex": 13, "endIndex": 14 } } ] }, { "kind": "Property", "canonicalReference": "(code:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "code" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "code", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(entityId:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "entityId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "entityId", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(entityName:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "entityName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "entityName", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false } ], "extendsTokenRange": { "startIndex": 11, "endIndex": 13 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(EntityRepository:interface)", "docComment": "/**\n * Base interface for a repository of entities\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "EntityRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ID" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "ExecutableRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ID", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "EntityRepository", "members": [], "extendsTokenRanges": [ { "startIndex": 9, "endIndex": 13 } ] }, { "kind": "Class", "canonicalReference": "(Event:class)", "docComment": "/**\n * Domain events\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "Event" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Event", "members": [ { "kind": "Property", "canonicalReference": "(source:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "source" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(type:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(ExecutableRepository:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ExecutableRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ExecutableRepository", "members": [ { "kind": "MethodSignature", "canonicalReference": "(execute:0)", "docComment": "/**\n * Execute a query with the given parameter object or an array of parameters\n *\n * @param command - The query string or command object\n *\n * @param parameters - The object with name/value pairs or an array of parameter values\n *\n * @param options - Options\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "execute" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "command" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Command" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "parameters" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "NamedParameters" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "PositionalParameters" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 16, "endIndex": 20 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "command", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "parameters", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 11 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 14, "endIndex": 15 } } ], "name": "execute" } ], "extendsTokenRanges": [ { "startIndex": 7, "endIndex": 11 } ] }, { "kind": "Interface", "canonicalReference": "(Filter:interface)", "docComment": "/**\n * Query filter object\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ], "name": "Filter", "members": [ { "kind": "PropertySignature", "canonicalReference": "fields", "docComment": "/**\n * To include/exclude fields\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "fields" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Fields" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "fields", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "include", "docComment": "/**\n * To include related objects\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "include" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Inclusion" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "include", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "limit", "docComment": "/**\n * Maximum number of entities\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "limit" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "limit", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "offset", "docComment": "/**\n * Offset N number of entities. An alias for `skip`\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "offset" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "order", "docComment": "/**\n * Sorting order for matched entities. Each item should be formatted as `fieldName ASC` or `fieldName DESC`. For example: `['f1 ASC', 'f2 DESC', 'f3 ASC']`.\n *\n * We might want to use `Order` in the future. Keep it as `string[]` for now for compatibility with LoopBack 3.x.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "order" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "order", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "skip", "docComment": "/**\n * Skip N number of entities\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "skip" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "skip", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "where", "docComment": "/**\n * The matching criteria\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "where", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(FilterBuilder:class)", "docComment": "/**\n * A builder for Filter. It provides fleunt APIs to add clauses such as `fields`, `order`, `where`, `limit`, `offset`, and `include`.\n *\n * @example\n * ```ts\n * const filterBuilder = new FilterBuilder();\n * const filter = filterBuilder\n * .fields('id', a', 'b')\n * .limit(10)\n * .offset(0)\n * .order(['a ASC', 'b DESC'])\n * .where({id: 1})\n * .build();\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "FilterBuilder" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ], "name": "FilterBuilder", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `FilterBuilder` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "f" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } } ] }, { "kind": "Method", "canonicalReference": "(build:instance,0)", "docComment": "/**\n * Return the filter object\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "build" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "build" }, { "kind": "Method", "canonicalReference": "(fields:instance,0)", "docComment": "/**\n * Describe what fields to be included/excluded\n *\n * @param f - A field name to be included, an array of field names to be included, or an Fields object for the inclusion/exclusion\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "fields" }, { "kind": "Content", "text": "(..." }, { "kind": "Reference", "text": "f" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "Fields" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "> | (keyof " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ")[] | keyof " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ")[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "f", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 13 } } ], "name": "fields" }, { "kind": "Property", "canonicalReference": "(filter:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "filter", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(impose:instance,0)", "docComment": "/**\n * Add a Filter or Where constraint object. If it is a filter object, create an `and` clause for conflicting keys with its where object. For any other properties, throw an error. If it's not a Filter, coerce it to a filter, and carry out the same logic.\n *\n * @param constraint - a constraint object to merge with own filter object\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "impose" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "constraint" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "constraint", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 12 } } ], "name": "impose" }, { "kind": "Method", "canonicalReference": "(include:instance,0)", "docComment": "/**\n * Declare `include`\n *\n * @param i - A relation name, an array of relation names, or an `Inclusion` object for the relation/scope definitions\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "include" }, { "kind": "Content", "text": "(..." }, { "kind": "Reference", "text": "i" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(string | string[] | " }, { "kind": "Reference", "text": "Inclusion" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">)[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "i", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 9 } } ], "name": "include" }, { "kind": "Method", "canonicalReference": "(limit:instance,0)", "docComment": "/**\n * Set `limit`\n *\n * @param limit - Maximum number of records to be returned\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "limit" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "limit" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "limit", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "limit" }, { "kind": "Method", "canonicalReference": "(offset:instance,0)", "docComment": "/**\n * Set `offset`\n *\n * @param offset - Offset of the number of records to be returned\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "offset" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "offset" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "offset", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "offset" }, { "kind": "Method", "canonicalReference": "(order:instance,0)", "docComment": "/**\n * Describe the sorting order\n *\n * @param o - A field name with optional direction, an array of field names, or an Order object for the field/direction pairs\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "order" }, { "kind": "Content", "text": "(..." }, { "kind": "Reference", "text": "o" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(string | string[] | " }, { "kind": "Reference", "text": "Order" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">)[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "o", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 9 } } ], "name": "order" }, { "kind": "Method", "canonicalReference": "(skip:instance,0)", "docComment": "/**\n * Alias to `offset`\n *\n * @param - skip\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "skip" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "skip" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "skip", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "skip" }, { "kind": "Method", "canonicalReference": "(where:instance,0)", "docComment": "/**\n * Declare a where clause\n *\n * @param w - Where object\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "w" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "w", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } } ], "name": "where" } ], "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(filterTemplate:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "filterTemplate" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "strings" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TemplateStringsArray" }, { "kind": "Content", "text": ", ..." }, { "kind": "Reference", "text": "keys" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "ctx" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ") => any" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "strings", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "keys", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "filterTemplate" }, { "kind": "Function", "canonicalReference": "(getModelRelations:0)", "docComment": "/**\n * Get metadata of all relations defined on a given model class.\n *\n * @param modelCtor - The model class (the constructor function).\n *\n * @returns A map of relation definitions\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "getModelRelations" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelCtor" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "RelationDefinitionMap" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelCtor", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 } } ], "name": "getModelRelations" }, { "kind": "Function", "canonicalReference": "(hasMany:0)", "docComment": "/**\n * Decorator for hasMany Calls property.array decorator underneath the hood and infers foreign key name from target model name unless explicitly specified\n *\n * @param targetResolver - Target model for hasMany relation\n *\n * @param definition - Optional metadata for setting up hasMany relation\n *\n * @returns A property decorator\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "hasMany" }, { "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": "HasManyDefinition" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "decoratedTarget" }, { "kind": "Content", "text": ": object, " }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": string) => void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 26 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "targetResolver", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } }, { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 20 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "hasMany" }, { "kind": "Interface", "canonicalReference": "(HasManyDefinition:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "HasManyDefinition" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "RelationDefinitionBase" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "HasManyDefinition", "members": [ { "kind": "PropertySignature", "canonicalReference": "keyTo", "docComment": "/**\n * The foreign key used by the target model.\n *\n * E.g. when a Customer has many Order instances, then keyTo is \"customerId\". Note that \"customerId\" is the default FK assumed by the framework, users can provide a custom FK name by setting \"keyTo\".\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "keyTo" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "keyTo", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "targetsMany", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "targetsMany" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "true" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "targetsMany", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "type", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RelationType" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "hasMany" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "(HasManyRepository:interface)", "docComment": "/**\n * CRUD operations for a target repository of a HasMany relation\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "HasManyRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "HasManyRepository", "members": [ { "kind": "MethodSignature", "canonicalReference": "(create:0)", "docComment": "/**\n * Create a target model instance\n *\n * @param targetModelData - The target model data\n *\n * @param options - Options for the operation\n *\n * @returns A promise which resolves to the newly created target model instance\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "targetModelData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "targetModelData", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "create" }, { "kind": "MethodSignature", "canonicalReference": "(delete:0)", "docComment": "/**\n * Delete multiple target model instances\n *\n * @param where - Instances within the where scope are deleted\n *\n * @param - options\n *\n * @returns A promise which resolves the deleted target model instances\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "delete" }, { "kind": "MethodSignature", "canonicalReference": "(find:0)", "docComment": "/**\n * Find target model instance(s)\n *\n * @param filter - A filter object for where, order, limit, etc.\n *\n * @param options - Options for the operation\n *\n * @returns A promise which resolves with the found target instance(s)\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "find" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": "[]>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "find" }, { "kind": "MethodSignature", "canonicalReference": "(patch:0)", "docComment": "/**\n * Patch multiple target model instances\n *\n * @param dataObject - The fields and their new values to patch\n *\n * @param where - Instances within the where scope are patched\n *\n * @param - options\n *\n * @returns A promise which resolves the patched target model instances\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "patch" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dataObject" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 20, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataObject", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 15 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 18, "endIndex": 19 } } ], "name": "patch" } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(hasOne:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "hasOne" }, { "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": "HasOneDefinition" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "decoratedTarget" }, { "kind": "Content", "text": ": object, " }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": string) => void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 26 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "targetResolver", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } }, { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 20 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "hasOne" }, { "kind": "Interface", "canonicalReference": "(HasOneDefinition:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "HasOneDefinition" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "RelationDefinitionBase" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "HasOneDefinition", "members": [ { "kind": "PropertySignature", "canonicalReference": "keyTo", "docComment": "/**\n * The foreign key used by the target model.\n *\n * E.g. when a Customer has one Address instance, then keyTo is \"customerId\". Note that \"customerId\" is the default FK assumed by the framework, users can provide a custom FK name by setting \"keyTo\".\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "keyTo" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "keyTo", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "targetsMany", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "targetsMany" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "false" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "targetsMany", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "type", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RelationType" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "hasOne" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "(HasOneRepository:interface)", "docComment": "/**\n * CRUD operations for a target repository of a HasMany relation\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "HasOneRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "HasOneRepository", "members": [ { "kind": "MethodSignature", "canonicalReference": "(create:0)", "docComment": "/**\n * Create a target model instance\n *\n * @param targetModelData - The target model data\n *\n * @param options - Options for the operation\n *\n * @returns A promise which resolves to the newly created target model instance\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "create" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "targetModelData" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "targetModelData", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "create" }, { "kind": "MethodSignature", "canonicalReference": "(delete:0)", "docComment": "/**\n * Delete the related target model instance\n *\n * @param - options\n *\n * @returns A promise which resolves the deleted target model instances\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "delete" }, { "kind": "MethodSignature", "canonicalReference": "(get:0)", "docComment": "/**\n * Find the only target model instance that belongs to the declaring model.\n *\n * @param filter - Query filter without a Where condition\n *\n * @param options - Options for the operations\n *\n * @returns A promise of the target object or null if not found.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "get" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Pick" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">, " }, { "kind": "Reference", "text": "Exclude" }, { "kind": "Content", "text": ", 'where'>>" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 25 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 16 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 } } ], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "(patch:0)", "docComment": "/**\n * Patch the related target model instance\n *\n * @param dataObject - The target model fields and their new values to patch\n *\n * @param - options\n *\n * @returns A promise which resolves the patched target model instances\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "patch" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dataObject" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Count" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataObject", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "patch" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(Inclusion:interface)", "docComment": "/**\n * Inclusion of related items\n *\n * Note: scope means filter on related items\n *\n * Example: `{relation: 'aRelationName', scope: {}}`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Inclusion" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ], "name": "Inclusion", "members": [ { "kind": "PropertySignature", "canonicalReference": "relation", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "relation" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "relation", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "scope", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "scope" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "scope", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(InvalidRelationError:class)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "InvalidRelationError" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Props" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Content", "text": "{}" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "Error" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "Props", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ], "name": "InvalidRelationError", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `InvalidRelationError` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "reason" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "relationMeta" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RelationMetadata" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "extraProperties" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Props" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "reason", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "parameterName": "relationMeta", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } }, { "parameterName": "extraProperties", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ] }, { "kind": "Property", "canonicalReference": "(code:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "code" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "code", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(reason:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "reason" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "reason", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(relationName:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "relationName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "relationName", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(relationType:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "relationType" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RelationType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "relationType", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(sourceModelName:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "sourceModelName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "sourceModelName", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false } ], "extendsTokenRange": { "startIndex": 9, "endIndex": 11 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(isBuiltinType:0)", "docComment": "/**\n * Check if the provided function is a built-in type provided by JavaScript and/or Node.js. E.g. `Number`, `Array`, `Buffer`, etc.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "isBuiltinType" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "fn" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "isBuiltinType" }, { "kind": "Function", "canonicalReference": "(isEntityNotFoundError:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "isEntityNotFoundError" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "e" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "e" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "EntityNotFoundError" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "isEntityNotFoundError" }, { "kind": "Function", "canonicalReference": "(isFilter:0)", "docComment": "/**\n * TypeGuard for Filter\n *\n * @param - candidate\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "isFilter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "candidate" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "candidate" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "candidate", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "isFilter" }, { "kind": "Function", "canonicalReference": "(isInvalidRelationError:0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "isInvalidRelationError" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "e" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "e" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "InvalidRelationError" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "isInvalidRelationError" }, { "kind": "Function", "canonicalReference": "(isTypeResolver:0)", "docComment": "/**\n * A function that checks whether a function is a TypeResolver or not.\n *\n * @param fn - The value to check.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "isTypeResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "fn" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "fn" }, { "kind": "Content", "text": " is " }, { "kind": "Reference", "text": "TypeResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 17 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "isTypeResolver" }, { "kind": "Namespace", "canonicalReference": "(juggler:namespace)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "juggler", "members": [] }, { "kind": "Interface", "canonicalReference": "(KeyValueRepository:interface)", "docComment": "/**\n * Key/Value operations for connector implementations\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "KeyValueRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "KeyValueRepository", "members": [ { "kind": "MethodSignature", "canonicalReference": "(delete:0)", "docComment": "/**\n * Delete an entry by key\n *\n * @param key - Key for the entry\n *\n * @param options - Options for the operation\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "delete" }, { "kind": "MethodSignature", "canonicalReference": "(deleteAll:0)", "docComment": "/**\n * Delete all entries\n *\n * @param key - Key for the entry\n *\n * @param options - Options for the operation\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "deleteAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "deleteAll" }, { "kind": "MethodSignature", "canonicalReference": "(expire:0)", "docComment": "/**\n * Set up ttl for an entry by key\n *\n * @param key - Key for the entry\n *\n * @param ttl - Ttl for the entry\n *\n * @param options - Options for the operation\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "expire" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ttl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "ttl", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 12, "endIndex": 13 } } ], "name": "expire" }, { "kind": "MethodSignature", "canonicalReference": "(get:0)", "docComment": "/**\n * Get an entry by key\n *\n * @param key - Key for the entry\n *\n * @param options - Options for the operation\n *\n * @returns A promise of the entry\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "get" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "(keys:0)", "docComment": "/**\n * Get an Iterator for matching keys\n *\n * @param filter - Filter for keys\n *\n * @param options - Options for the operation\n *\n * @returns An async iteratable iterator of keys so that the return value can be used with `for-await-of`.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "keys" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "KeyValueFilter" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "AsyncIterable" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "keys" }, { "kind": "MethodSignature", "canonicalReference": "(set:0)", "docComment": "/**\n * Set an entry with key/value\n *\n * @param key - Key for the entry\n *\n * @param value - Value for the entry\n *\n * @param options - Options for the operation\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "set" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "set" }, { "kind": "MethodSignature", "canonicalReference": "(ttl:0)", "docComment": "/**\n * Get ttl for an entry by key\n *\n * @param key - Key for the entry\n *\n * @param options - Options for the operation\n *\n * @returns A promise of the TTL value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "ttl" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "ttl" } ], "extendsTokenRanges": [ { "startIndex": 7, "endIndex": 11 } ] }, { "kind": "Interface", "canonicalReference": "(KVConnector:interface)", "docComment": "/**\n * Key/Value operations for connector implementations\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "KVConnector" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "Connector" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "KVConnector", "members": [ { "kind": "MethodSignature", "canonicalReference": "(delete:0)", "docComment": "/**\n * Delete an entry by key\n *\n * @param modelClass - Model class\n *\n * @param key - Key for the entry\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entry is deleted for the id, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "delete" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "delete" }, { "kind": "MethodSignature", "canonicalReference": "(deleteAll:0)", "docComment": "/**\n * Delete all entries\n *\n * @param modelClass - Model class\n *\n * @param options - Options for the operation\n *\n * @returns A promise of the number of entries deleted\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "deleteAll" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "deleteAll" }, { "kind": "MethodSignature", "canonicalReference": "(expire:0)", "docComment": "/**\n * Set up ttl for an entry by key\n *\n * @param modelClass - Model class\n *\n * @param key - Key for the entry\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entry is configured for the key, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "expire" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ttl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 23 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "ttl", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 } } ], "name": "expire" }, { "kind": "MethodSignature", "canonicalReference": "(get:0)", "docComment": "/**\n * Get an entry by key\n *\n * @param modelClass - Model class\n *\n * @param key - Key for the entry\n *\n * @param options - Options for the operation\n *\n * @returns A promise of the entry found for the key\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "get" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "get" }, { "kind": "MethodSignature", "canonicalReference": "(iterateKeys:0)", "docComment": "/**\n * Get an Iterator for matching keys\n *\n * @param modelClass - Model class\n *\n * @param filter - Matching filter\n *\n * @param options - Options for the operation\n *\n * @returns A promise of an iterator of entries\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "iterateKeys" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "filter" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Filter" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Iterator" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 17, "endIndex": 23 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "filter", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "name": "iterateKeys" }, { "kind": "MethodSignature", "canonicalReference": "(keys:0)", "docComment": "/**\n * Fetch all keys\n *\n * @param modelClass - Model class\n *\n * @param key - Key for the entry\n *\n * @param options - Options for the operation\n *\n * @returns A promise of an array of keys for all entries\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "keys" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } } ], "name": "keys" }, { "kind": "MethodSignature", "canonicalReference": "(set:0)", "docComment": "/**\n * Set an entry with key/value\n *\n * @param modelClass - Model class\n *\n * @param key - Key for the entry\n *\n * @param value - Value for the entry\n *\n * @param options - Options for the operation\n *\n * @returns Promise if an entry is set for the key, otherwise Promise\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "set" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 23 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 } } ], "name": "set" }, { "kind": "MethodSignature", "canonicalReference": "(ttl:0)", "docComment": "/**\n * Get ttl for an entry by key\n *\n * @param modelClass - Model class\n *\n * @param key - Key for the entry\n *\n * @param ttl - Time to live in millisenconds\n *\n * @param options - Options for the operation\n *\n * @returns A promise of the TTL value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "ttl" }, { "kind": "Content", "text": "?(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ttl" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 21, "endIndex": 23 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } }, { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "ttl", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 19, "endIndex": 20 } } ], "name": "ttl" } ], "extendsTokenRanges": [ { "startIndex": 7, "endIndex": 9 } ] }, { "kind": "Function", "canonicalReference": "(model:0)", "docComment": "/**\n * Decorator for model definitions\n *\n * @param - definition\n *\n * @returns A class decorator for `model`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "model" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Partial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ModelDefinitionSyntax" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "target" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": " & {\n " }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "ModelDefinition" }, { "kind": "Content", "text": " | undefined;\n}) => void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 } } ], "name": "model" }, { "kind": "Class", "canonicalReference": "(Model:class)", "docComment": "/**\n * Base class for models\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Model", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `Model` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "data" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "data", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } } ] }, { "kind": "Property", "canonicalReference": "(definition:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ModelDefinition" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "definition", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Property", "canonicalReference": "(modelName:static)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "static readonly " }, { "kind": "Reference", "text": "modelName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": true }, { "kind": "Method", "canonicalReference": "(toJSON:instance,0)", "docComment": "/**\n * Serialize into a plain JSON object\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "toJSON" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "toJSON" }, { "kind": "Method", "canonicalReference": "(toObject:instance,0)", "docComment": "/**\n * Convert to a plain object as DTO\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "toObject" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "toObject" } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(ModelDefinition:class)", "docComment": "/**\n * Definition for a model\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ModelDefinition" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ModelDefinition", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `ModelDefinition` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "nameOrDef" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "ModelDefinitionSyntax" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "nameOrDef", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 } } ] }, { "kind": "IndexSignature", "canonicalReference": "(:index,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "attribute" }, { "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": "attribute", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(addProperty:instance,0)", "docComment": "/**\n * Add a property\n *\n * @param name - Property definition or name (string)\n *\n * @param definitionOrType - Definition or property type\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "addProperty" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "definitionOrType" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "PropertyType" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 12, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "definitionOrType", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 11 } } ], "name": "addProperty" }, { "kind": "Method", "canonicalReference": "(addRelation:instance,0)", "docComment": "/**\n * Define a new relation.\n *\n * @param definition - The definition of the new relation.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "addRelation" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RelationMetadata" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "addRelation" }, { "kind": "Method", "canonicalReference": "(addSetting:instance,0)", "docComment": "/**\n * Add a setting\n *\n * @param name - Setting name\n *\n * @param value - Setting value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "addSetting" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "addSetting" }, { "kind": "Method", "canonicalReference": "(idProperties:instance,0)", "docComment": "/**\n * Get an array of names of ID properties, which are specified in the model settings or properties with `id` attribute.\n *\n * @example\n * ```ts\n * {\n * settings: {\n * id: ['id']\n * }\n * properties: {\n * id: {\n * type: 'string',\n * id: true\n * }\n * }\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "idProperties" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "idProperties" }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(properties:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "properties" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": string]: " }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 7 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(relations:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "relations" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RelationDefinitionMap" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "relations", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(settings:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "settings" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": string]: any;\n }" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "settings", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(ModelDefinitionSyntax:interface)", "docComment": "/**\n * DSL for building a model definition.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "ModelDefinitionSyntax" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ModelDefinitionSyntax", "members": [ { "kind": "IndexSignature", "canonicalReference": "(:index,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "attribute" }, { "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": "attribute", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "PropertySignature", "canonicalReference": "name", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "properties", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "properties" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": string]: " }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "PropertyType" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 9 } }, { "kind": "PropertySignature", "canonicalReference": "relations", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "relations" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "RelationDefinitionMap" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "relations", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "settings", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "settings" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": string]: any;\n }" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "settings", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(ModelMetadataHelper:class)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ModelMetadataHelper" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ModelMetadataHelper", "members": [ { "kind": "Method", "canonicalReference": "(getModelMetadata:static,0)", "docComment": "/**\n * A utility function to simplify retrieving metadata from a target model and its properties.\n *\n * @param target - The class from which to retrieve metadata.\n *\n * @param options - An options object for the MetadataInspector to customize the output of the metadata retrieval functions.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static " }, { "kind": "Reference", "text": "getModelMetadata" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "target" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "InspectionOptions" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "ModelDefinition" }, { "kind": "Content", "text": " | {}" }, { "kind": "Content", "text": ";" } ], "isStatic": true, "returnTypeTokenRange": { "startIndex": 11, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "target", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "getModelMetadata" } ], "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(ModelType:class)", "docComment": "/**\n * Model type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ModelType" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": "> extends " }, { "kind": "Reference", "text": "ObjectType" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ModelType", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `ModelType` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelClass", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } } ] }, { "kind": "Property", "canonicalReference": "(modelClass:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "modelClass", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(serialize:instance,0)", "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": "Reference", "text": "Object" }, { "kind": "Content", "text": " | null | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "serialize" } ], "extendsTokenRange": { "startIndex": 7, "endIndex": 11 }, "implementsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(NumberType:class)", "docComment": "/**\n * Number type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "NumberType" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "NumberType", "members": [ { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": " = \"number\";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(serialize:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "serialize" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "number | null | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "number | null | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "(ObjectType:class)", "docComment": "/**\n * Object type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "ObjectType" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "AnyObject" }, { "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": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "ObjectType", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `ObjectType` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } } ] }, { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(serialize:instance,0)", "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" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "serialize" }, { "kind": "Property", "canonicalReference": "(type:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false } ], "implementsTokenRanges": [ { "startIndex": 7, "endIndex": 11 } ] }, { "kind": "Interface", "canonicalReference": "(OrClause:interface)", "docComment": "/**\n * Or clause\n *\n * @example\n * ```ts\n * {\n * or: [...],\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "OrClause" }, { "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": "OrClause", "members": [ { "kind": "PropertySignature", "canonicalReference": "or", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "or" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "or", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(Persistable:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Persistable" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "Persistable", "members": [], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(property:1)", "docComment": "/**\n * Decorator for model properties\n *\n * @param - definition\n *\n * @returns A property decorator\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "property" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Partial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PropertyDecorator" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 9 } } ], "name": "property" }, { "kind": "Namespace", "canonicalReference": "(property:namespace)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace " }, { "kind": "Reference", "text": "property" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "property", "members": [ { "kind": "Function", "canonicalReference": "(array:0)", "docComment": "/**\n * @param itemType - The type of array items. Examples: `number`, `Product`, `() => Order`.\n *\n * @param definition - Optional PropertyDefinition object for additional metadata\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function " }, { "kind": "Reference", "text": "array" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "itemType" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "PropertyType" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Partial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "target" }, { "kind": "Content", "text": ": object, " }, { "kind": "Reference", "text": "propertyName" }, { "kind": "Content", "text": ": string) => void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 14, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "itemType", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } }, { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } } ], "name": "array" }, { "kind": "Variable", "canonicalReference": "ERR_NO_ARGS", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ERR_NO_ARGS" }, { "kind": "Content", "text": " = \"decorator received less than two parameters\"" } ], "releaseTag": "Public", "name": "ERR_NO_ARGS", "variableTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "kind": "Variable", "canonicalReference": "ERR_PROP_NOT_ARRAY", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ERR_PROP_NOT_ARRAY" }, { "kind": "Content", "text": " = \"@property.array can only decorate array properties!\"" } ], "releaseTag": "Public", "name": "ERR_PROP_NOT_ARRAY", "variableTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ] }, { "kind": "Interface", "canonicalReference": "(PropertyDefinition:interface)", "docComment": "/**\n * Property definition for a model\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PropertyDefinition", "members": [ { "kind": "IndexSignature", "canonicalReference": "(:index,0)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "attribute" }, { "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": "attribute", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "PropertySignature", "canonicalReference": "id", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "id" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean | number" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "itemType", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "itemType" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PropertyType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "itemType", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "json", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "json" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PropertyForm" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "json", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "jsonSchema", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "jsonSchema" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "attribute" }, { "kind": "Content", "text": ": string]: any;\n }" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "jsonSchema", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "store", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "store" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PropertyForm" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "store", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "type", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "PropertyType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "(PropertyForm:interface)", "docComment": "/**\n * See https://github.com/strongloop/loopback-datasource-juggler/issues/432\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "PropertyForm" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PropertyForm", "members": [ { "kind": "PropertySignature", "canonicalReference": "in", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "in" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "in", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "name", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "out", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "out" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "out", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(referencesMany:0)", "docComment": "/**\n * Decorator for referencesMany\n *\n * @param - definition\n *\n * @returns A property decorator\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "referencesMany" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PropertyDecorator" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "referencesMany" }, { "kind": "Function", "canonicalReference": "(referencesOne:0)", "docComment": "/**\n * Decorator for referencesOne\n *\n * @param - definition\n *\n * @returns A property decorator\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "referencesOne" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PropertyDecorator" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "referencesOne" }, { "kind": "Function", "canonicalReference": "(relation:0)", "docComment": "/**\n * Decorator for relations\n *\n * @param - definition\n *\n * @returns A property decorator\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "relation" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "definition" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "PropertyDecorator" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "definition", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "name": "relation" }, { "kind": "Interface", "canonicalReference": "(RelationDefinitionBase:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "RelationDefinitionBase" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "RelationDefinitionBase", "members": [ { "kind": "PropertySignature", "canonicalReference": "name", "docComment": "/**\n * The relation name, typically matching the name of the accessor property defined on the source model. For example \"orders\" or \"customer\".\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "source", "docComment": "/**\n * The source model of this relation.\n *\n * E.g. when a Customer has many Order instances, then Customer is the source.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "source" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "source", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "target", "docComment": "/**\n * The target model of this relation.\n *\n * E.g. when a Customer has many Order instances, then Order is the target.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "target" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TypeResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", typeof " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "target", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 8 } }, { "kind": "PropertySignature", "canonicalReference": "targetsMany", "docComment": "/**\n * True for relations targeting multiple instances (e.g. HasMany), false for relations with a single target (e.g. BelongsTo, HasOne). This property is needed by OpenAPI/JSON Schema generator.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "targetsMany" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "targetsMany", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "type", "docComment": "/**\n * The type of the relation, must be one of RelationType values.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "RelationType" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "(RelationType:enum)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum " }, { "kind": "Reference", "text": "RelationType" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "RelationType", "members": [ { "kind": "EnumMember", "canonicalReference": "belongsTo", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "belongsTo" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"belongsTo\"" } ], "releaseTag": "Public", "name": "belongsTo", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "embedsMany", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "embedsMany" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"embedsMany\"" } ], "releaseTag": "Public", "name": "embedsMany", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "embedsOne", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "embedsOne" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"embedsOne\"" } ], "releaseTag": "Public", "name": "embedsOne", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "hasMany", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "hasMany" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"hasMany\"" } ], "releaseTag": "Public", "name": "hasMany", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "hasOne", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "hasOne" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"hasOne\"" } ], "releaseTag": "Public", "name": "hasOne", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "referencesMany", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "referencesMany" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"referencesMany\"" } ], "releaseTag": "Public", "name": "referencesMany", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "EnumMember", "canonicalReference": "referencesOne", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "referencesOne" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "\"referencesOne\"" } ], "releaseTag": "Public", "name": "referencesOne", "initializerTokenRange": { "startIndex": 2, "endIndex": 3 } } ] }, { "kind": "Function", "canonicalReference": "(repository:1)", "docComment": "/**\n * Decorator for repository injections on properties or method arguments\n *\n * @param repositoryName - Name of the repo\n *\n * @example\n * ```ts\n * class CustomerController {\n * @repository(CustomerRepository) public custRepo: CustomerRepository;\n *\n * constructor(\n * @repository(ProductRepository) public prodRepo: ProductRepository,\n * ) {}\n * // ...\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "repository" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "repositoryName" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "RepositoryDecorator" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 14 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "repositoryName", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 12 } } ], "name": "repository" }, { "kind": "Function", "canonicalReference": "(repository:2)", "docComment": "/**\n * Decorator for DefaultCrudRepository generation and injection on properties or method arguments based on the given model and dataSource (or their names)\n *\n * @param model - Name/class of the model\n *\n * @param dataSource - Name/instance of the dataSource\n *\n * @example\n * ```ts\n * class CustomerController {\n * @repository('Customer', 'mySqlDataSource')\n * public custRepo: DefaultCrudRepository<\n * Customer,\n * typeof Customer.prototype.id\n * >;\n *\n * constructor(\n * @repository(Product, mySqlDataSource)\n * public prodRepo: DefaultCrudRepository<\n * Product,\n * typeof Product.prototype.id\n * >,\n * ) {}\n * // ...\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "repository" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "model" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string | typeof " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "RepositoryDecorator" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 15, "endIndex": 16 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "model", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 7 } }, { "parameterName": "dataSource", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 14 } } ], "name": "repository" }, { "kind": "Interface", "canonicalReference": "(Repository:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "Repository", "members": [], "extendsTokenRanges": [] }, { "kind": "Namespace", "canonicalReference": "(repository:namespace)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare namespace " }, { "kind": "Reference", "text": "repository" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "repository", "members": [ { "kind": "Function", "canonicalReference": "(getter:0)", "docComment": "/**\n * Decorator used to inject a Getter for a repository Mainly intended for usage with repository injections on relation repository factory\n *\n * @param nameOrClass - The repository class (ProductRepository) or a string name ('ProductRepository').\n */\n", "excerptTokens": [ { "kind": "Content", "text": "function " }, { "kind": "Reference", "text": "getter" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "nameOrClass" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "target" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "member" }, { "kind": "Content", "text": ": string, " }, { "kind": "Reference", "text": "methodDescriptorOrParameterIndex" }, { "kind": "Content", "text": "?: number | " }, { "kind": "Reference", "text": "TypedPropertyDescriptor" }, { "kind": "Content", "text": " | undefined) => void" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 13, "endIndex": 24 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "nameOrClass", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 12 } } ], "name": "getter" } ] }, { "kind": "Class", "canonicalReference": "(RepositoryMetadata:class)", "docComment": "/**\n * Metadata for a repository\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "RepositoryMetadata" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "RepositoryMetadata", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructor for RepositoryMetadata\n *\n * @param modelOrRepo - Name or class of the model. If the value is a string and `dataSource` is not present, it will treated as the name of a predefined repository\n *\n * @param dataSource - Name or instance of the data source\n *\n * For example:\n *\n * - new RepositoryMetadata(repoName); - new RepositoryMetadata(modelName, dataSourceName); - new RepositoryMetadata(modelClass, dataSourceInstance); - new RepositoryMetadata(modelName, dataSourceInstance); - new RepositoryMetadata(modelClass, dataSourceName);\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "modelOrRepo" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string | typeof " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "modelOrRepo", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "parameterName": "dataSource", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 14 } } ] }, { "kind": "Property", "canonicalReference": "(dataSource:instance)", "docComment": "/**\n * Instance of the data source\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "dataSource", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 7 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(dataSourceName:instance)", "docComment": "/**\n * Name of the data source\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "dataSourceName" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "dataSourceName", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(modelClass:instance)", "docComment": "/**\n * Class of the model\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "modelClass" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "typeof " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "modelClass", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(modelName:instance)", "docComment": "/**\n * Name of the model\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "modelName" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "modelName", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "/**\n * Name of the predefined repository\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(RepositoryMixin:0)", "docComment": "/**\n * A mixin class for Application that creates a .repository() function to register a repository automatically. Also overrides component function to allow it to register repositories automatically.\n *\n * @example\n * ```ts\n * class MyApplication extends RepositoryMixin(Application) {}\n * ```\n *\n * Please note: the members in the mixin function are documented in a dummy class called RepositoryMixinDoc\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "RepositoryMixin" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "superClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "{\n new (..." }, { "kind": "Reference", "text": "args" }, { "kind": "Content", "text": ": any[]): {\n [" }, { "kind": "Reference", "text": "x" }, { "kind": "Content", "text": ": string]: any;\n " }, { "kind": "Reference", "text": "repository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "repoClass" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": ">, " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: string | undefined): " }, { "kind": "Reference", "text": "Binding" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": ">;\n " }, { "kind": "Reference", "text": "getRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Repository" }, { "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": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": ">;\n " }, { "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": "D" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "D" }, { "kind": "Content", "text": ">, " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: string | undefined): " }, { "kind": "Reference", "text": "Binding" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "D" }, { "kind": "Content", "text": ">;\n " }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: string | undefined): void;\n " }, { "kind": "Reference", "text": "mountComponentRepositories" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "): void;\n " }, { "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": ";\n };\n} & " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 12, "endIndex": 96 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "superClass", "parameterTypeTokenRange": { "startIndex": 10, "endIndex": 11 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 7 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "RepositoryMixin" }, { "kind": "Class", "canonicalReference": "(RepositoryMixinDoc:class)", "docComment": "/**\n * A dummy class created to generate the tsdoc for the members in repository mixin. Please don't use it.\n *\n * The members are implemented in function RepositoryMixin\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "RepositoryMixinDoc" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "RepositoryMixinDoc", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `RepositoryMixinDoc` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(..." }, { "kind": "Reference", "text": "args" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "args", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 } } ] }, { "kind": "Method", "canonicalReference": "(component:instance,0)", "docComment": "/**\n * Add a component to this application. Also mounts all the components repositories.\n *\n * @param component - The component to add.\n *\n * @example\n * ```ts\n *\n * export class ProductComponent {\n * controllers = [ProductController];\n * repositories = [ProductRepo, UserRepo];\n * providers = {\n * [AUTHENTICATION_STRATEGY]: AuthStrategy,\n * [AUTHORIZATION_ROLE]: Role,\n * };\n * };\n *\n * app.component(ProductComponent);\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<{}>" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Binding" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "component", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "component" }, { "kind": "Method", "canonicalReference": "(dataSource:instance,0)", "docComment": "/**\n * Add the dataSource to this application.\n *\n * @param dataSource - The dataSource to add.\n *\n * @param name - The binding name of the datasource; defaults to dataSource.name\n *\n * @example\n * ```ts\n *\n * const ds: juggler.DataSource = new juggler.DataSource({\n * name: 'db',\n * connector: 'memory',\n * });\n *\n * app.dataSource(ds);\n *\n * // The datasource can be injected with\n * constructor(@inject('datasources.db') dataSource: DataSourceType) {\n *\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "dataSource" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "juggler" }, { "kind": "Content", "text": "." }, { "kind": "Reference", "text": "DataSource" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Binding" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 18, "endIndex": 19 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "dataSource", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 13 } }, { "parameterName": "name", "parameterTypeTokenRange": { "startIndex": 16, "endIndex": 17 } } ], "name": "dataSource" }, { "kind": "Method", "canonicalReference": "(getRepository:instance,0)", "docComment": "/**\n * Retrieve the repository instance from the given Repository class\n *\n * @param repo - The repository class to retrieve the instance of\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "getRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "R" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": "" }, { "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": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "repo", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 13 } } ], "typeParameters": [ { "typeParameterName": "R", "constraintTokenRange": { "startIndex": 4, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "getRepository" }, { "kind": "Method", "canonicalReference": "(migrateSchema:instance,0)", "docComment": "/**\n * Update or recreate the database schema for all repositories.\n *\n * **WARNING**: By default, `migrateSchema()` will attempt to preserve data while updating the schema in your target database, but this is not guaranteed to be safe.\n *\n * Please check the documentation for your specific connector(s) for a detailed breakdown of behaviors for automigrate!\n *\n * @param options - Migration options, e.g. whether to update tables preserving data or rebuild everything from scratch.\n */\n", "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": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "migrateSchema" }, { "kind": "Method", "canonicalReference": "(mountComponentRepository:instance,0)", "docComment": "/**\n * Get an instance of a component and mount all it's repositories. This function is intended to be used internally by component()\n *\n * @param component - The component to mount repositories of\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "mountComponentRepository" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "component" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<{}>" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "component", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } } ], "name": "mountComponentRepository" }, { "kind": "Method", "canonicalReference": "(repository:instance,0)", "docComment": "/**\n * Add a repository to this application.\n *\n * @param repo - The repository to add.\n *\n * @example\n * ```ts\n *\n * class NoteRepo {\n * model: any;\n *\n * constructor() {\n * const ds: juggler.DataSource = new juggler.DataSource({\n * name: 'db',\n * connector: 'memory',\n * });\n *\n * this.model = ds.createModel(\n * 'note',\n * {title: 'string', content: 'string'},\n * {}\n * );\n * }\n * };\n *\n * app.repository(NoteRepo);\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "repository" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "repo" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Repository" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Binding" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "repo", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } } ], "name": "repository" } ], "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "(resolveType:1)", "docComment": "/**\n * Resolve a type value that may have been provided via TypeResolver.\n *\n * @param fn - A type class or a type provider.\n *\n * @returns The resolved type.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "resolveType" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "fn" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "TypeResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 18, "endIndex": 22 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 17 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "resolveType" }, { "kind": "Function", "canonicalReference": "(resolveType:2)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare function " }, { "kind": "Reference", "text": "resolveType" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "fn" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 2, "parameters": [ { "parameterName": "fn", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ], "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "resolveType" }, { "kind": "Interface", "canonicalReference": "(SchemaMigrationOptions:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "kind": "Reference", "text": "SchemaMigrationOptions" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "SchemaMigrationOptions", "members": [ { "kind": "PropertySignature", "canonicalReference": "existingSchema", "docComment": "/**\n * When set to 'drop', schema migration will drop existing tables and recreate them from scratch, removing any existing data along the way.\n *\n * When set to 'alter', schema migration will try to preserve current schema and data, and perform a non-destructive incremental update.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "existingSchema" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "'drop' | 'alter'" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "existingSchema", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "models", "docComment": "/**\n * List of model names to migrate.\n *\n * By default, all models are migrated.\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "models" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "models", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "(StringType:class)", "docComment": "/**\n * String type\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "StringType" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "StringType", "members": [ { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "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": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": " = \"string\";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(serialize:instance,0)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "serialize" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string | null | undefined" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string | null | undefined" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Interface", "canonicalReference": "(Type:interface)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface " }, { "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": "Type", "members": [ { "kind": "MethodSignature", "canonicalReference": "(coerce:0)", "docComment": "/**\n * Coerce the value into this type\n *\n * @param value - The value to be coerced\n *\n * @param options - Options for coercion\n *\n * @returns Coerced value of this type\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "coerce" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " | null | undefined" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "coerce" }, { "kind": "MethodSignature", "canonicalReference": "(defaultValue:0)", "docComment": "/**\n * Generate the default value for this type\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "defaultValue" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " | null | undefined" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "defaultValue" }, { "kind": "MethodSignature", "canonicalReference": "(isCoercible:0)", "docComment": "/**\n * Check if the given value can be coerced into this type\n *\n * @param value - The value to to be coerced\n *\n * @returns A flag to indicate if the value can be coerced\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "isCoercible" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "value" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 10, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 8, "endIndex": 9 } } ], "name": "isCoercible" }, { "kind": "MethodSignature", "canonicalReference": "(isInstance:0)", "docComment": "/**\n * Test if the given value is an instance of this type\n *\n * @param value - The value\n */\n", "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": ";" } ], "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "MethodSignature", "canonicalReference": "(serialize:0)", "docComment": "/**\n * Serialize a value into json\n *\n * @param value - The value of this type\n *\n * @param options - Options for serialization\n */\n", "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": "Reference", "text": "options" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "returnTypeTokenRange": { "startIndex": 11, "endIndex": 12 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 6 } }, { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "name": "serialize" }, { "kind": "PropertySignature", "canonicalReference": "name", "docComment": "/**\n * Name of the type\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Class", "canonicalReference": "(UnionType:class)", "docComment": "/**\n * Union type, such as string | number\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "UnionType" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "UnionType", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `UnionType` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "itemTypes" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "itemTypes", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 } } ] }, { "kind": "Method", "canonicalReference": "(coerce:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "coerce" }, { "kind": "Method", "canonicalReference": "(defaultValue:instance,0)", "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": 0, "parameters": [], "name": "defaultValue" }, { "kind": "Method", "canonicalReference": "(isCoercible:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isCoercible" }, { "kind": "Method", "canonicalReference": "(isInstance:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "isInstance" }, { "kind": "Property", "canonicalReference": "(itemTypes:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "itemTypes" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "itemTypes", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 4 }, "isStatic": false }, { "kind": "Property", "canonicalReference": "(name:instance)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly " }, { "kind": "Reference", "text": "name" }, { "kind": "Content", "text": " = \"union\";" } ], "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 0, "endIndex": 0 }, "isStatic": false }, { "kind": "Method", "canonicalReference": "(serialize:instance,0)", "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": 0, "parameters": [ { "parameterName": "value", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 } } ], "name": "serialize" } ], "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 5 } ] }, { "kind": "Class", "canonicalReference": "(ValueObject:class)", "docComment": "/**\n * Base class for value objects - An object that contains attributes but has no conceptual identity. They should be treated as immutable.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare abstract class " }, { "kind": "Reference", "text": "ValueObject" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": " " }, { "kind": "Content", "text": "implements " }, { "kind": "Reference", "text": "Persistable" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ValueObject", "members": [], "extendsTokenRange": { "startIndex": 3, "endIndex": 5 }, "implementsTokenRanges": [ { "startIndex": 6, "endIndex": 8 } ] }, { "kind": "Class", "canonicalReference": "(WhereBuilder:class)", "docComment": "/**\n * A builder for Where object. It provides fluent APIs to add clauses such as `and`, `or`, and other operators.\n *\n * @example\n * ```ts\n * const whereBuilder = new WhereBuilder();\n * const where = whereBuilder\n * .eq('a', 1)\n * .and({x: 'x'}, {y: {gt: 1}})\n * .and({b: 'b'}, {c: {lt: 1}})\n * .or({d: 'd'}, {e: {neq: 1}})\n * .build();\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class " }, { "kind": "Reference", "text": "WhereBuilder" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "> " } ], "releaseTag": "Public", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ], "name": "WhereBuilder", "members": [ { "kind": "Constructor", "canonicalReference": "(:constructor,0)", "docComment": "/**\n * Constructs a new instance of the `WhereBuilder` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(" }, { "kind": "Reference", "text": "w" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "w", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 7 } } ] }, { "kind": "Method", "canonicalReference": "(and:instance,0)", "docComment": "/**\n * Add an `and` clause.\n *\n * @param w - One or more where objects\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "and" }, { "kind": "Content", "text": "(..." }, { "kind": "Reference", "text": "w" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">[])[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "w", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 13 } } ], "name": "and" }, { "kind": "Method", "canonicalReference": "(between:instance,0)", "docComment": "/**\n * Add a `between` condition\n *\n * @param key - Property name\n *\n * @param val1 - Property value lower bound\n *\n * @param val2 - Property value upper bound\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "between" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val1" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val2" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 27, "endIndex": 28 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val1", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } }, { "parameterName": "val2", "parameterTypeTokenRange": { "startIndex": 22, "endIndex": 26 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "between" }, { "kind": "Method", "canonicalReference": "(build:instance,0)", "docComment": "/**\n * Get the where object\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "build" }, { "kind": "Content", "text": "(): " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [], "name": "build" }, { "kind": "Method", "canonicalReference": "(cast:instance,0)", "docComment": "/**\n * @deprecated\n *\n * Starting from TypeScript 3.2, we don't have to cast any more. This method should be considered as `deprecated`.\n *\n * Cast an `and`, `or`, or condition clause to Where\n *\n * @param clause - And/Or/Condition clause\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "cast" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "clause" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AndClause" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "OrClause" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "Condition" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "clause", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 16 } } ], "name": "cast" }, { "kind": "Method", "canonicalReference": "(eq:instance,0)", "docComment": "/**\n * Add an `=` condition\n *\n * @param key - Property name\n *\n * @param val - Property value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "eq" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "eq" }, { "kind": "Method", "canonicalReference": "(exists:instance,0)", "docComment": "/**\n * Add a `exists` condition\n *\n * @param key - Property name\n *\n * @param val - Exists or not\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "exists" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": "?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 17, "endIndex": 18 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 16 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "exists" }, { "kind": "Method", "canonicalReference": "(gt:instance,0)", "docComment": "/**\n * Add a `>` condition\n *\n * @param key - Property name\n *\n * @param val - Property value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "gt" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "gt" }, { "kind": "Method", "canonicalReference": "(gte:instance,0)", "docComment": "/**\n * Add a `>=` condition\n *\n * @param key - Property name\n *\n * @param val - Property value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "gte" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "gte" }, { "kind": "Method", "canonicalReference": "(impose:instance,0)", "docComment": "/**\n * Add a where object. For conflicting keys with the existing where object, create an `and` clause.\n *\n * @param where - Where filter\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "impose" }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "where", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 8 } } ], "name": "impose" }, { "kind": "Method", "canonicalReference": "(inq:instance,0)", "docComment": "/**\n * Add a `inq` condition\n *\n * @param key - Property name\n *\n * @param val - An array of property values\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "inq" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "][]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "inq" }, { "kind": "Method", "canonicalReference": "(lt:instance,0)", "docComment": "/**\n * Add a `<` condition\n *\n * @param key - Property name\n *\n * @param val - Property value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "lt" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "lt" }, { "kind": "Method", "canonicalReference": "(lte:instance,0)", "docComment": "/**\n * Add a `<=` condition\n *\n * @param key - Property name\n *\n * @param val - Property value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "lte" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "lte" }, { "kind": "Method", "canonicalReference": "(neq:instance,0)", "docComment": "/**\n * Add a `!=` condition\n *\n * @param key - Property name\n *\n * @param val - Property value\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "neq" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "neq" }, { "kind": "Method", "canonicalReference": "(nin:instance,0)", "docComment": "/**\n * Add a `nin` condition\n *\n * @param key - Property name\n *\n * @param val - An array of property values\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "nin" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ">(" }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "val" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "K" }, { "kind": "Content", "text": "][]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 20, "endIndex": 21 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 11, "endIndex": 12 } }, { "parameterName": "val", "parameterTypeTokenRange": { "startIndex": 15, "endIndex": 19 } } ], "typeParameters": [ { "typeParameterName": "K", "constraintTokenRange": { "startIndex": 4, "endIndex": 8 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "name": "nin" }, { "kind": "Method", "canonicalReference": "(or:instance,0)", "docComment": "/**\n * Add an `or` clause.\n *\n * @param w - One or more where objects\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "or" }, { "kind": "Content", "text": "(..." }, { "kind": "Reference", "text": "w" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">[])[]" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "this" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 14, "endIndex": 15 }, "releaseTag": "Public", "overloadIndex": 0, "parameters": [ { "parameterName": "w", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 13 } } ], "name": "or" }, { "kind": "Property", "canonicalReference": "(where:instance)", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "where" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "where", "propertyTypeTokenRange": { "startIndex": 2, "endIndex": 6 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "ANY", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "ANY" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "AnyType" } ], "releaseTag": "Public", "name": "ANY", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "BelongsToAccessor", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "BelongsToAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "SourceId" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "sourceId" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "SourceId" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "Promise" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "BelongsToAccessor", "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "SourceId", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 9, "endIndex": 18 } }, { "kind": "Variable", "canonicalReference": "BOOLEAN", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "BOOLEAN" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BooleanType" } ], "releaseTag": "Public", "name": "BOOLEAN", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "Variable", "canonicalReference": "BUFFER", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "BUFFER" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "BufferType" } ], "releaseTag": "Public", "name": "BUFFER", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "Callback", "docComment": "/**\n * Type alias for Node.js callback functions\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Callback" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "err" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Error" }, { "kind": "Content", "text": " | string | null | undefined, " }, { "kind": "Reference", "text": "result" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ") => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Callback", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 14 } }, { "kind": "TypeAlias", "canonicalReference": "Command", "docComment": "/**\n * Type for a command\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Command" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Command", "typeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "Condition", "docComment": "/**\n * Condition clause\n *\n * @example\n * ```ts\n * {\n * name: {inq: ['John', 'Mary']},\n * status: 'ACTIVE',\n * age: {gte: 40}\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Condition" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "P" }, { "kind": "Content", "text": " in " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">]?: " }, { "kind": "Reference", "text": "PredicateComparison" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "P" }, { "kind": "Content", "text": "]> | (" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "P" }, { "kind": "Content", "text": "] & " }, { "kind": "Reference", "text": "ShortHandEqualType" }, { "kind": "Content", "text": ");\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Condition", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 7, "endIndex": 26 } }, { "kind": "TypeAlias", "canonicalReference": "Constructor", "docComment": "/**\n * Constructor type - class or function\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Constructor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> = " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "ConstructorFunction" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Constructor", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 13 } }, { "kind": "Variable", "canonicalReference": "CountSchema", "docComment": "/**\n * JSON Schema describing the Count interface. It's the response type for REST calls to APIs which return Count\n */\n", "excerptTokens": [ { "kind": "Reference", "text": "CountSchema" }, { "kind": "Content", "text": ": " }, { "kind": "Content", "text": "{\n " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": string;\n " }, { "kind": "Reference", "text": "properties" }, { "kind": "Content", "text": ": {\n " }, { "kind": "Reference", "text": "count" }, { "kind": "Content", "text": ": {\n " }, { "kind": "Reference", "text": "type" }, { "kind": "Content", "text": ": string;\n };\n };\n}" } ], "releaseTag": "Public", "name": "CountSchema", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 11 } }, { "kind": "TypeAlias", "canonicalReference": "DataObject", "docComment": "/**\n * Type alias for strongly or weakly typed objects of T\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "DataObject" }, { "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": " | " }, { "kind": "Reference", "text": "DeepPartial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "DataObject", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 7, "endIndex": 13 } }, { "kind": "Variable", "canonicalReference": "DATE", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "DATE" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "DateType" } ], "releaseTag": "Public", "name": "DATE", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "DeepPartial", "docComment": "/**\n * An extension of the built-in Partial type which allows partial values in deeply nested properties too.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "DeepPartial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "P" }, { "kind": "Content", "text": " in keyof " }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "]?: " }, { "kind": "Reference", "text": "DeepPartial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "P" }, { "kind": "Content", "text": "]>;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "DeepPartial", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 16 } }, { "kind": "TypeAlias", "canonicalReference": "Direction", "docComment": "/**\n * Order by direction\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Direction" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "'ASC' | 'DESC'" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Direction", "typeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "EntityData", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "EntityData" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "DataObject" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "EntityData", "typeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "EntityResolver", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "EntityResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": "> = " }, { "kind": "Reference", "text": "TypeResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "T" }, { "kind": "Content", "text": ", typeof " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "EntityResolver", "typeParameters": [ { "typeParameterName": "T", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 7, "endIndex": 13 } }, { "kind": "TypeAlias", "canonicalReference": "Fields", "docComment": "/**\n * Selection of fields\n *\n * Example: `{afieldname: true}`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Fields" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "P" }, { "kind": "Content", "text": " in keyof " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "]?: boolean;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Fields", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "typeTokenRange": { "startIndex": 7, "endIndex": 12 } }, { "kind": "TypeAlias", "canonicalReference": "HasManyRepositoryFactory", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "HasManyRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "fkValue" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "HasManyRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "HasManyRepositoryFactory", "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ForeignKeyType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 9, "endIndex": 18 } }, { "kind": "TypeAlias", "canonicalReference": "HasOneRepositoryFactory", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "HasOneRepositoryFactory" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Entity" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "fkValue" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "ForeignKeyType" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "HasOneRepository" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Target" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "HasOneRepositoryFactory", "typeParameters": [ { "typeParameterName": "Target", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "ForeignKeyType", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 9, "endIndex": 18 } }, { "kind": "TypeAlias", "canonicalReference": "KeyOf", "docComment": "/**\n * Key types of a given model, excluding operators\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "KeyOf" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object" }, { "kind": "Content", "text": "> = " }, { "kind": "Reference", "text": "Exclude" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Extract" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "Operators" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "KeyOf", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 7, "endIndex": 15 } }, { "kind": "TypeAlias", "canonicalReference": "KeyValueFilter", "docComment": "/**\n * Filter for keys\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "KeyValueFilter" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "{\n " }, { "kind": "Reference", "text": "match" }, { "kind": "Content", "text": ": string;\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "KeyValueFilter", "typeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "Variable", "canonicalReference": "MODEL_KEY", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "MODEL_KEY" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MetadataAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Partial" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ModelDefinitionSyntax" }, { "kind": "Content", "text": ">, " }, { "kind": "Reference", "text": "ClassDecorator" }, { "kind": "Content", "text": ">" } ], "releaseTag": "Public", "name": "MODEL_KEY", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 10 } }, { "kind": "Variable", "canonicalReference": "MODEL_PROPERTIES_KEY", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "MODEL_PROPERTIES_KEY" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MetadataAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PropertyDecorator" }, { "kind": "Content", "text": ">" } ], "releaseTag": "Public", "name": "MODEL_PROPERTIES_KEY", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 8 } }, { "kind": "Variable", "canonicalReference": "MODEL_WITH_PROPERTIES_KEY", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "MODEL_WITH_PROPERTIES_KEY" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "MetadataAccessor" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ModelDefinition" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "ClassDecorator" }, { "kind": "Content", "text": ">" } ], "releaseTag": "Public", "name": "MODEL_WITH_PROPERTIES_KEY", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "NamedParameters", "docComment": "/**\n * Named parameters, such as `{x: 1, y: 'a'}`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "NamedParameters" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "NamedParameters", "typeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "Variable", "canonicalReference": "NUMBER", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "NUMBER" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "NumberType" } ], "releaseTag": "Public", "name": "NUMBER", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "Operators", "docComment": "/**\n * Operators for where clauses\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Operators" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'inq' | 'nin' | 'between' | 'exists' | 'and' | 'or' | 'like' | 'nlike' | 'ilike' | 'nilike' | 'regexp'" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Operators", "typeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "Options", "docComment": "/**\n * Type alias for Node.js options object\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Options" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Options", "typeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "Order", "docComment": "/**\n * Order by\n *\n * Example: `{afieldname: 'ASC'}`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Order" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "P" }, { "kind": "Content", "text": " in keyof " }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "Direction" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Order", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 5, "endIndex": 6 } } ], "typeTokenRange": { "startIndex": 7, "endIndex": 14 } }, { "kind": "TypeAlias", "canonicalReference": "PositionalParameters", "docComment": "/**\n * Positional parameters, such as [1, 'a']\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "PositionalParameters" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "any[]" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "PositionalParameters", "typeTokenRange": { "startIndex": 3, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "PredicateComparison", "docComment": "/**\n * Matching predicate comparison\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "PredicateComparison" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "{\n " }, { "kind": "Reference", "text": "eq" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "neq" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "gt" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "gte" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "lt" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "lte" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "inq" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": "[];\n " }, { "kind": "Reference", "text": "nin" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": "[];\n " }, { "kind": "Reference", "text": "between" }, { "kind": "Content", "text": "?: [" }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": "];\n " }, { "kind": "Reference", "text": "exists" }, { "kind": "Content", "text": "?: boolean;\n " }, { "kind": "Reference", "text": "like" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "nlike" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "ilike" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "nilike" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "PT" }, { "kind": "Content", "text": ";\n " }, { "kind": "Reference", "text": "regexp" }, { "kind": "Content", "text": "?: string | " }, { "kind": "Reference", "text": "RegExp" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "PredicateComparison", "typeParameters": [ { "typeParameterName": "PT", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } } ], "typeTokenRange": { "startIndex": 5, "endIndex": 66 } }, { "kind": "TypeAlias", "canonicalReference": "PropertyMap", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "PropertyMap" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "MetadataMap" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "PropertyDefinition" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "PropertyMap", "typeTokenRange": { "startIndex": 3, "endIndex": 7 } }, { "kind": "TypeAlias", "canonicalReference": "PropertyType", "docComment": "/**\n * This module defines the key classes representing building blocks for Domain Driven Design. See https://en.wikipedia.org/wiki/Domain-driven_design#Building_blocks\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "PropertyType" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": " | object | " }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "TypeResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Model" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "PropertyType", "typeTokenRange": { "startIndex": 3, "endIndex": 12 } }, { "kind": "TypeAlias", "canonicalReference": "RelationDefinitionMap", "docComment": "/**\n * A key-value map describing model relations. A relation name is used as the key, a relation definition is the value.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "RelationDefinitionMap" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "{\n [" }, { "kind": "Reference", "text": "relationName" }, { "kind": "Content", "text": ": string]: " }, { "kind": "Reference", "text": "RelationMetadata" }, { "kind": "Content", "text": ";\n}" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "RelationDefinitionMap", "typeTokenRange": { "startIndex": 3, "endIndex": 8 } }, { "kind": "TypeAlias", "canonicalReference": "RelationMetadata", "docComment": "/**\n * A union type describing all possible Relation metadata objects.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "RelationMetadata" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "HasManyDefinition" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "BelongsToDefinition" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "HasOneDefinition" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "RelationDefinitionBase" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "RelationMetadata", "typeTokenRange": { "startIndex": 3, "endIndex": 10 } }, { "kind": "Variable", "canonicalReference": "RELATIONS_KEY", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "RELATIONS_KEY" }, { "kind": "Content", "text": " = \"loopback:relations\"" } ], "releaseTag": "Public", "name": "RELATIONS_KEY", "variableTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "kind": "TypeAlias", "canonicalReference": "RepositoryDecorator", "docComment": "/**\n * Type definition for decorators returned by `@repository` decorator factory\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "RepositoryDecorator" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "(" }, { "kind": "Reference", "text": "target" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "key" }, { "kind": "Content", "text": "?: string, " }, { "kind": "Reference", "text": "descriptorOrIndex" }, { "kind": "Content", "text": "?: " }, { "kind": "Reference", "text": "TypedPropertyDescriptor" }, { "kind": "Content", "text": " | number) => void" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "RepositoryDecorator", "typeTokenRange": { "startIndex": 3, "endIndex": 14 } }, { "kind": "TypeAlias", "canonicalReference": "ShortHandEqualType", "docComment": "/**\n * Value types for `{propertyName: value}`\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "ShortHandEqualType" }, { "kind": "Content", "text": " = " }, { "kind": "Content", "text": "string | number | boolean | " }, { "kind": "Reference", "text": "Date" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "ShortHandEqualType", "typeTokenRange": { "startIndex": 3, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "STRING", "docComment": "", "excerptTokens": [ { "kind": "Reference", "text": "STRING" }, { "kind": "Content", "text": ": " }, { "kind": "Reference", "text": "StringType" } ], "releaseTag": "Public", "name": "STRING", "variableTypeTokenRange": { "startIndex": 2, "endIndex": 3 } }, { "kind": "TypeAlias", "canonicalReference": "TypeResolver", "docComment": "/**\n * A type resolver is a function that returns a class representing the type, typically a Model or Entity (e.g. Product).\n *\n * We use type resolvers to break require() loops when defining relations. The target model (class) is provided via a provider, thus deferring the actual reference to the class itself until later, when both sides of the relation are created as JavaScript classes.\n *\n * @typeParam Type - The type we are resolving, for example `Entity` or `Product`. This parameter is required.\n *\n * @typeParam StaticMembers - The static properties available on the type class. For example, all models have static `modelName` property. When `StaticMembers` are not provided, we default to static properties of a `Function` - `name`, `length`, `apply`, `call`, etc. Please note the value returned by the resolver is described as having arbitrary additional static properties (see how Class is defined).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "TypeResolver" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": " extends " }, { "kind": "Reference", "text": "Object" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "StaticMembers" }, { "kind": "Content", "text": " = " }, { "kind": "Reference", "text": "Function" }, { "kind": "Content", "text": "> = " }, { "kind": "Content", "text": "() => " }, { "kind": "Reference", "text": "Class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Type" }, { "kind": "Content", "text": "> & " }, { "kind": "Reference", "text": "StaticMembers" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TypeResolver", "typeParameters": [ { "typeParameterName": "Type", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 0, "endIndex": 0 } }, { "typeParameterName": "StaticMembers", "constraintTokenRange": { "startIndex": 0, "endIndex": 0 }, "defaultTypeTokenRange": { "startIndex": 9, "endIndex": 10 } } ], "typeTokenRange": { "startIndex": 11, "endIndex": 17 } }, { "kind": "TypeAlias", "canonicalReference": "Where", "docComment": "/**\n * Where clause\n *\n * @example\n * ```ts\n * {\n * name: {inq: ['John', 'Mary']},\n * status: 'ACTIVE'\n * and: [...],\n * or: [...],\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type " }, { "kind": "Reference", "text": "Where" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": " extends " }, { "kind": "Content", "text": "object " }, { "kind": "Content", "text": "= " }, { "kind": "Reference", "text": "AnyObject" }, { "kind": "Content", "text": "> = " }, { "kind": "Reference", "text": "Condition" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "AndClause" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": "> | " }, { "kind": "Reference", "text": "OrClause" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MT" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "Where", "typeParameters": [ { "typeParameterName": "MT", "constraintTokenRange": { "startIndex": 5, "endIndex": 6 }, "defaultTypeTokenRange": { "startIndex": 7, "endIndex": 8 } } ], "typeTokenRange": { "startIndex": 9, "endIndex": 21 } } ] } ] }