Skip to main content
Version: 0.17

@orbit/records

Enumerations

Classes

Interfaces

Type aliases

AddRecordOperationResult

Ƭ AddRecordOperationResult: InitializedRecord

Defined in

packages/@orbit/records/src/record-operation.ts:110


AddToRelatedRecordsOperationResult

Ƭ AddToRelatedRecordsOperationResult: undefined

Defined in

packages/@orbit/records/src/record-operation.ts:115


AsyncRecordQueryable

Ƭ AsyncRecordQueryable<ResponseDetails, QueryBuilder, QueryOptions>: AsyncQueryable<RecordQueryResult, ResponseDetails, RecordOperation, RecordQueryExpression, QueryBuilder, QueryOptions>

Type parameters

NameType
ResponseDetailsResponseDetails
QueryBuilderRecordQueryBuilder
QueryOptionsextends RequestOptions = RequestOptions

Defined in

packages/@orbit/records/src/record-queryable.ts:20


AsyncRecordUpdatable

Ƭ AsyncRecordUpdatable<ResponseDetails, TransformBuilder, TransformOptions>: AsyncUpdatable<RecordTransformResult, ResponseDetails, RecordOperation, TransformBuilder, TransformOptions>

Type parameters

NameType
ResponseDetailsResponseDetails
TransformBuilderRecordTransformBuilder
TransformOptionsextends RequestOptions = RequestOptions

Defined in

packages/@orbit/records/src/record-updatable.ts:18


FilterParam

Ƭ FilterParam<RI>: FilterSpecifier | AttributeFilterParam | RelatedRecordFilterParam<RI> | RelatedRecordsFilterParam<RI>

Type parameters

NameType
RIRecordIdentity

Defined in

packages/@orbit/records/src/record-query-term.ts:57


FilterSpecifier

Ƭ FilterSpecifier: BaseFilterSpecifier | AttributeFilterSpecifier | RelatedRecordFilterSpecifier | RelatedRecordsFilterSpecifier

Defined in

packages/@orbit/records/src/record-query-expression.ts:47


FindRecordResult

Ƭ FindRecordResult: InitializedRecord | undefined

Defined in

packages/@orbit/records/src/record-query-expression.ts:100


FindRecordsResult

Ƭ FindRecordsResult: InitializedRecord[]

Defined in

packages/@orbit/records/src/record-query-expression.ts:103


FindRelatedRecordResult

Ƭ FindRelatedRecordResult: InitializedRecord | null | undefined

Defined in

packages/@orbit/records/src/record-query-expression.ts:101


FindRelatedRecordsResult

Ƭ FindRelatedRecordsResult: InitializedRecord[] | undefined

Defined in

packages/@orbit/records/src/record-query-expression.ts:102


Ƭ Link: string | LinkObject

Defined in

packages/@orbit/records/src/record.ts:8


PageSpecifier

Ƭ PageSpecifier: BasePageSpecifier | OffsetLimitPageSpecifier

Defined in

packages/@orbit/records/src/record-query-expression.ts:63


RecordAttributeValidationIssue

Ƭ RecordAttributeValidationIssue: TypeIssue | RecordFieldDefinitionIssue | ValueRequiredIssue | ValueNotNullIssue | ValueValidIssue

Defined in

packages/@orbit/records/src/record-validators/record-attribute-validator.ts:51


RecordAttributeValidator

Ƭ RecordAttributeValidator: Validator<RecordAttributeInput, RecordAttributeValidationOptions, RecordAttributeValidationIssue>

Defined in

packages/@orbit/records/src/record-validators/record-attribute-validator.ts:64


RecordFieldDefinitionValidator

Ƭ RecordFieldDefinitionValidator: Validator<RecordFieldDefinitionInput, RecordFieldDefinitionValidationOptions, RecordFieldDefinitionIssue>

Defined in

packages/@orbit/records/src/record-validators/record-field-definition-validator.ts:22


RecordIdentityValidationIssue

Ƭ RecordIdentityValidationIssue: TypeIssue | RecordTypeValidationIssue

Defined in

packages/@orbit/records/src/record-validators/record-identity-validator.ts:28


RecordIdentityValidator

Ƭ RecordIdentityValidator: Validator<RecordIdentity, RecordIdentityValidationOptions, RecordIdentityValidationIssue>

Defined in

packages/@orbit/records/src/record-validators/record-identity-validator.ts:38


RecordKeyValidationIssue

Ƭ RecordKeyValidationIssue: RecordFieldDefinitionIssue | ValueRequiredIssue | ValueNotNullIssue | ValueValidIssue

Defined in

packages/@orbit/records/src/record-validators/record-key-validator.ts:46


RecordKeyValidator

Ƭ RecordKeyValidator: Validator<RecordKeyInput, RecordKeyValidationOptions, RecordKeyValidationIssue>

Defined in

packages/@orbit/records/src/record-validators/record-key-validator.ts:58


RecordOperation

Ƭ RecordOperation: AddRecordOperation | UpdateRecordOperation | RemoveRecordOperation | ReplaceKeyOperation | ReplaceAttributeOperation | AddToRelatedRecordsOperation | RemoveFromRelatedRecordsOperation | ReplaceRelatedRecordsOperation | ReplaceRelatedRecordOperation

Union of all record-related operations.

Defined in

packages/@orbit/records/src/record-operation.ts:99


RecordOperationResult

Ƭ RecordOperationResult<T>: T | undefined

Type parameters

NameType
TInitializedRecord

Defined in

packages/@orbit/records/src/record-operation.ts:120


RecordOperationTerm

Ƭ RecordOperationTerm<RT, RI, R>: AddRecordTerm<RT, RI, R> | UpdateRecordTerm<RT, RI, R> | RemoveRecordTerm<RT, RI, R> | ReplaceKeyTerm<RT, RI, R> | ReplaceAttributeTerm<RT, RI, R> | AddToRelatedRecordsTerm<RT, RI, R> | RemoveFromRelatedRecordsTerm<RT, RI, R> | ReplaceRelatedRecordsTerm<RT, RI, R> | ReplaceRelatedRecordTerm<RT, RI, R>

Type parameters

NameType
RTstring
RIRecordIdentity
RUninitializedRecord

Defined in

packages/@orbit/records/src/record-operation-term.ts:241


RecordOperationValidationIssue

Ƭ RecordOperationValidationIssue: OperationAllowedIssue | OperationValidIssue

Defined in

packages/@orbit/records/src/record-validators/record-operation-validator.ts:44


RecordOperationValidator

Ƭ RecordOperationValidator: Validator<RecordOperation, RecordOperationValidationOptions, RecordOperationValidationIssue>

Defined in

packages/@orbit/records/src/record-validators/record-operation-validator.ts:48


RecordPullable

Ƭ RecordPullable<ResponseDetails>: Pullable<RecordQueryResult, ResponseDetails, RecordOperation, RecordQueryExpression, RecordQueryBuilder>

Type parameters

Name
ResponseDetails

Defined in

packages/@orbit/records/src/record-source-interfaces/record-pullable.ts:7


RecordPushable

Ƭ RecordPushable<ResponseDetails>: Pushable<RecordTransformResult, ResponseDetails, RecordOperation, RecordTransformBuilder>

Type parameters

Name
ResponseDetails

Defined in

packages/@orbit/records/src/record-source-interfaces/record-pushable.ts:6


RecordQuery

Ƭ RecordQuery: Query<RecordQueryExpression>

Defined in

packages/@orbit/records/src/record-query.ts:8


RecordQueryBuilderFunc

Ƭ RecordQueryBuilderFunc: QueryBuilderFunc<RecordQueryExpression, RecordQueryBuilder>

Defined in

packages/@orbit/records/src/record-query-builder.ts:21


RecordQueryExpression

Ƭ RecordQueryExpression: FindRecord | FindRelatedRecord | FindRelatedRecords | FindRecords

Defined in

packages/@orbit/records/src/record-query-expression.ts:94


RecordQueryExpressionResult

Ƭ RecordQueryExpressionResult<T>: T | T[] | null | undefined

Type parameters

NameType
TInitializedRecord

Defined in

packages/@orbit/records/src/record-query-expression.ts:105


RecordQueryResult

Ƭ RecordQueryResult<T>: RecordQueryExpressionResult<T> | RecordQueryExpressionResult<T>[]

Type parameters

NameType
TInitializedRecord

Defined in

packages/@orbit/records/src/record-query.ts:10


RecordQueryTerm

Ƭ RecordQueryTerm<RT, RI>: FindRecordTerm<RT, RI> | FindRelatedRecordTerm<RT, RI> | FindRecordsTerm<RT, RI>

Type parameters

NameType
RTstring
RIRecordIdentity

Defined in

packages/@orbit/records/src/record-query-term.ts:344


RecordQueryable

Ƭ RecordQueryable<ResponseDetails, QueryBuilder, QueryOptions>: Queryable<RecordQueryResult, ResponseDetails, RecordOperation, RecordQueryExpression, QueryBuilder, QueryOptions>

Type parameters

NameType
ResponseDetailsResponseDetails
QueryBuilderRecordQueryBuilder
QueryOptionsextends RequestOptions = RequestOptions

Defined in

packages/@orbit/records/src/record-source-interfaces/record-queryable.ts:7


RecordRelationship

Ƭ RecordRelationship: RecordHasOneRelationship | RecordHasManyRelationship

Defined in

packages/@orbit/records/src/record.ts:27


RecordRelationshipValidationIssue

Ƭ RecordRelationshipValidationIssue: RecordFieldDefinitionIssue | RequiredIssue | NotNullIssue | DataValidIssue

Defined in

packages/@orbit/records/src/record-validators/record-relationship-validator.ts:51


RecordRelationshipValidator

Ƭ RecordRelationshipValidator: Validator<RecordRelationshipInput, RecordRelationshipValidationOptions, RecordRelationshipValidationIssue>

Defined in

packages/@orbit/records/src/record-validators/record-relationship-validator.ts:63


RecordSchemaEvent

Ƭ RecordSchemaEvent: "upgrade"

Defined in

packages/@orbit/records/src/record-schema.ts:108


RecordSourceClass

Ƭ RecordSourceClass<QO, TO, QB, TB>: SourceClass<QO, TO, QB, TB>

Type parameters

NameType
QOextends RequestOptions = RecordSourceQueryOptions
TOextends RequestOptions = RequestOptions
QBRecordQueryBuilder
TBRecordTransformBuilder

Defined in

packages/@orbit/records/src/record-source.ts:67


RecordSyncable

Ƭ RecordSyncable: Syncable<RecordOperation, RecordTransformBuilder>

Defined in

packages/@orbit/records/src/record-source-interfaces/record-syncable.ts:5


RecordTransform

Ƭ RecordTransform: Transform<RecordOperation>

Defined in

packages/@orbit/records/src/record-transform.ts:5


RecordTransformBuilderFunc

Ƭ RecordTransformBuilderFunc: TransformBuilderFunc<RecordOperation, RecordTransformBuilder>

Defined in

packages/@orbit/records/src/record-transform-builder.ts:28


RecordTransformResult

Ƭ RecordTransformResult<T>: RecordOperationResult<T> | RecordOperationResult<T>[]

Type parameters

NameType
TInitializedRecord

Defined in

packages/@orbit/records/src/record-transform.ts:7


RecordTypeValidationIssue

Ƭ RecordTypeValidationIssue: TypeIssue | RecordTypeDefined

Defined in

packages/@orbit/records/src/record-validators/record-type-validator.ts:19


RecordTypeValidator

Ƭ RecordTypeValidator: Validator<string, RecordTypeValidationOptions, RecordTypeValidationIssue>

Defined in

packages/@orbit/records/src/record-validators/record-type-validator.ts:25


RecordUpdatable

Ƭ RecordUpdatable<ResponseDetails, TransformBuilder, TransformOptions>: Updatable<RecordTransformResult, ResponseDetails, RecordOperation, TransformBuilder, TransformOptions>

Type parameters

NameType
ResponseDetailsResponseDetails
TransformBuilderRecordTransformBuilder
TransformOptionsextends RequestOptions = RequestOptions

Defined in

packages/@orbit/records/src/record-source-interfaces/record-updatable.ts:6


RecordValidationIssue

Ƭ RecordValidationIssue: RecordIdentityValidationIssue | RecordKeyValidationIssue | RecordAttributeValidationIssue | RecordRelationshipValidationIssue

Defined in

packages/@orbit/records/src/record-validators/record-validator.ts:30


RecordValidator

Ƭ RecordValidator: Validator<InitializedRecord, RecordValidationOptions, RecordValidationIssue>

Defined in

packages/@orbit/records/src/record-validators/record-validator.ts:43


RelatedRecordValidationIssue

Ƭ RelatedRecordValidationIssue: RecordFieldDefinitionIssue | RelatedRecordValidIssue | RelatedRecordTypeIssue

Defined in

packages/@orbit/records/src/record-validators/related-record-validator.ts:48


RelatedRecordValidator

Ƭ RelatedRecordValidator: Validator<RelatedRecordInput, RelatedRecordValidationOptions, RelatedRecordValidationIssue>

Defined in

packages/@orbit/records/src/record-validators/related-record-validator.ts:59


RelationshipDefinition

Ƭ RelationshipDefinition: HasOneRelationshipDefinition | HasManyRelationshipDefinition

Defined in

packages/@orbit/records/src/record-schema.ts:51


RemoveFromRelatedRecordsOperationResult

Ƭ RemoveFromRelatedRecordsOperationResult: undefined

Defined in

packages/@orbit/records/src/record-operation.ts:116


RemoveRecordOperationResult

Ƭ RemoveRecordOperationResult: undefined

Defined in

packages/@orbit/records/src/record-operation.ts:112


ReplaceAttributeOperationResult

Ƭ ReplaceAttributeOperationResult: undefined

Defined in

packages/@orbit/records/src/record-operation.ts:114


ReplaceKeyOperationResult

Ƭ ReplaceKeyOperationResult: undefined

Defined in

packages/@orbit/records/src/record-operation.ts:113


ReplaceRelatedRecordOperationResult

Ƭ ReplaceRelatedRecordOperationResult: undefined

Defined in

packages/@orbit/records/src/record-operation.ts:118


ReplaceRelatedRecordsOperationResult

Ƭ ReplaceRelatedRecordsOperationResult: undefined

Defined in

packages/@orbit/records/src/record-operation.ts:117


SetComparisonOperator

Ƭ SetComparisonOperator: "equal" | "all" | "some" | "none"

Defined in

packages/@orbit/records/src/record-query-expression.ts:19


SortOrder

Ƭ SortOrder: "ascending" | "descending"

Defined in

packages/@orbit/records/src/record-query-expression.ts:4


SortParam

Ƭ SortParam: SortSpecifier | AttributeSortParam | string

Defined in

packages/@orbit/records/src/record-query-term.ts:32


SortSpecifier

Ƭ SortSpecifier: BaseSortSpecifier | AttributeSortSpecifier

Defined in

packages/@orbit/records/src/record-query-expression.ts:16


StandardRecordValidator

Ƭ StandardRecordValidator: RecordValidator | RecordAttributeValidator | RecordIdentityValidator | RecordKeyValidator | RecordOperationValidator | RecordQueryExpressionValidator | RecordRelationshipValidator | RecordTypeValidator | RelatedRecordValidator | RecordFieldDefinitionValidator

Defined in

packages/@orbit/records/src/record-validators/standard-record-validators.ts:25


SyncRecordQueryable

Ƭ SyncRecordQueryable<ResponseDetails, QueryBuilder, QueryOptions>: SyncQueryable<RecordQueryResult, ResponseDetails, RecordOperation, RecordQueryExpression, QueryBuilder, QueryOptions>

Type parameters

NameType
ResponseDetailsResponseDetails
QueryBuilderRecordQueryBuilder
QueryOptionsextends RequestOptions = RequestOptions

Defined in

packages/@orbit/records/src/record-queryable.ts:7


SyncRecordUpdatable

Ƭ SyncRecordUpdatable<ResponseDetails, TransformBuilder, TransformOptions>: SyncUpdatable<RecordTransformResult, ResponseDetails, RecordOperation, TransformBuilder, TransformOptions>

Type parameters

NameType
ResponseDetailsResponseDetails
TransformBuilderRecordTransformBuilder
TransformOptionsextends RequestOptions = RequestOptions

Defined in

packages/@orbit/records/src/record-updatable.ts:6


UpdateRecordOperationResult

Ƭ UpdateRecordOperationResult: undefined

Defined in

packages/@orbit/records/src/record-operation.ts:111


ValueComparisonOperator

Ƭ ValueComparisonOperator: "equal" | "gt" | "lt" | "gte" | "lte"

Defined in

packages/@orbit/records/src/record-query-expression.ts:18

Variables

standardRecordValidators

standardRecordValidators: Dict<StandardRecordValidator>

Defined in

packages/@orbit/records/src/record-validators/standard-record-validator-dict.ts:14

Functions

buildRecordValidatorFor

buildRecordValidatorFor(settings?): ValidatorForFn<StandardValidator | StandardRecordValidator>

Parameters

NameType
settings?Object
settings.validators?Dict<StandardValidator | StandardRecordValidator>

Returns

ValidatorForFn<StandardValidator | StandardRecordValidator>

Defined in

packages/@orbit/records/src/record-validators/record-validator-builder.ts:11


cloneRecordIdentity

cloneRecordIdentity(identity): RecordIdentity

Parameters

NameType
identityRecordIdentity

Returns

RecordIdentity

Defined in

packages/@orbit/records/src/record.ts:64


coalesceRecordOperations

coalesceRecordOperations(operations): RecordOperation[]

Coalesces operations into a minimal set of equivalent operations.

This method respects the order of the operations array and does not allow reordering of operations that affect relationships.

Parameters

NameType
operationsRecordOperation[]

Returns

RecordOperation[]

Defined in

packages/@orbit/records/src/record-operation.ts:393


dedupeRecordIdentities

dedupeRecordIdentities(recordIdentities): RecordIdentity[]

Parameters

NameType
recordIdentitiesRecordIdentity[]

Returns

RecordIdentity[]

Defined in

packages/@orbit/records/src/record.ts:112


deserializeRecordIdentity

deserializeRecordIdentity(identity): RecordIdentity

Parameters

NameType
identitystring

Returns

RecordIdentity

Defined in

packages/@orbit/records/src/record.ts:224


equalRecordIdentities

equalRecordIdentities(record1?, record2?): boolean

Parameters

NameType
record1?null | RecordIdentity
record2?null | RecordIdentity

Returns

boolean

Defined in

packages/@orbit/records/src/record.ts:69


equalRecordIdentitySets

equalRecordIdentitySets(set1, set2): boolean

Parameters

NameType
set1RecordIdentity[]
set2RecordIdentity[]

Returns

boolean

Defined in

packages/@orbit/records/src/record.ts:82


isRecordIdentity

isRecordIdentity(identity): identity is RecordIdentity

Parameters

NameType
identityunknown

Returns

identity is RecordIdentity

Defined in

packages/@orbit/records/src/record.ts:213


mergeRecords

mergeRecords(current, updates): InitializedRecord

Parameters

NameType
currentnull | InitializedRecord
updatesInitializedRecord

Returns

InitializedRecord

Defined in

packages/@orbit/records/src/record.ts:151


recordDiffs

recordDiffs(record, updatedRecord): RecordOperation[]

Determine the differences between a record and its updated version in terms of a set of operations.

Parameters

NameType
recordInitializedRecord
updatedRecordInitializedRecord

Returns

RecordOperation[]

Defined in

packages/@orbit/records/src/record-operation.ts:420


recordsInclude

recordsInclude(records, match): boolean

Parameters

NameType
recordsRecordIdentity[]
matchRecordIdentity

Returns

boolean

Defined in

packages/@orbit/records/src/record.ts:127


recordsIncludeAll

recordsIncludeAll(records, match): boolean

Parameters

NameType
recordsRecordIdentity[]
matchRecordIdentity[]

Returns

boolean

Defined in

packages/@orbit/records/src/record.ts:139


recordsReferencedByOperations

recordsReferencedByOperations(operations): RecordIdentity[]

Returns the deduped identities of all the records directly referenced by an array of operations.

Parameters

NameType
operationsRecordOperation[]

Returns

RecordIdentity[]

Defined in

packages/@orbit/records/src/record-operation.ts:509


serializeRecordIdentity

serializeRecordIdentity(record): string

Parameters

NameType
recordRecordIdentity

Returns

string

Defined in

packages/@orbit/records/src/record.ts:220


uniqueRecordIdentities

uniqueRecordIdentities(set1, set2): RecordIdentity[]

Parameters

NameType
set1RecordIdentity[]
set2RecordIdentity[]

Returns

RecordIdentity[]

Defined in

packages/@orbit/records/src/record.ts:102


validateRecord

Const validateRecord(input, options?): undefined | RecordValidationIssue[]

Parameters

NameType
inputInitializedRecord
options?RecordValidationOptions

Returns

undefined | RecordValidationIssue[]

Defined in

packages/@orbit/records/src/record-validators/record-validator.ts:49


validateRecordAttribute

Const validateRecordAttribute(input, options?): undefined | RecordAttributeValidationIssue[]

Parameters

NameType
inputRecordAttributeInput
options?RecordAttributeValidationOptions

Returns

undefined | RecordAttributeValidationIssue[]

Defined in

packages/@orbit/records/src/record-validators/record-attribute-validator.ts:70


validateRecordFieldDefinition

Const validateRecordFieldDefinition(input, options?): undefined | RecordFieldDefinitionIssue[]

Parameters

NameType
inputRecordFieldDefinitionInput
options?RecordFieldDefinitionValidationOptions

Returns

undefined | RecordFieldDefinitionIssue[]

Defined in

packages/@orbit/records/src/record-validators/record-field-definition-validator.ts:28


validateRecordIdentity

Const validateRecordIdentity(input, options?): undefined | RecordIdentityValidationIssue[]

Parameters

NameType
inputRecordIdentity
options?RecordIdentityValidationOptions

Returns

undefined | RecordIdentityValidationIssue[]

Defined in

packages/@orbit/records/src/record-validators/record-identity-validator.ts:44


validateRecordKey

Const validateRecordKey(input, options?): undefined | RecordKeyValidationIssue[]

Parameters

NameType
inputRecordKeyInput
options?RecordKeyValidationOptions

Returns

undefined | RecordKeyValidationIssue[]

Defined in

packages/@orbit/records/src/record-validators/record-key-validator.ts:64


validateRecordOperation

Const validateRecordOperation(input, options?): undefined | RecordOperationValidationIssue[]

Parameters

NameType
inputRecordOperation
options?RecordOperationValidationOptions

Returns

undefined | RecordOperationValidationIssue[]

Defined in

packages/@orbit/records/src/record-validators/record-operation-validator.ts:54


validateRecordRelationship

Const validateRecordRelationship(input, options?): undefined | RecordRelationshipValidationIssue[]

Parameters

NameType
inputRecordRelationshipInput
options?RecordRelationshipValidationOptions

Returns

undefined | RecordRelationshipValidationIssue[]

Defined in

packages/@orbit/records/src/record-validators/record-relationship-validator.ts:69


validateRecordType

Const validateRecordType(input, options?): undefined | RecordTypeValidationIssue[]

Parameters

NameType
inputstring
options?RecordTypeValidationOptions

Returns

undefined | RecordTypeValidationIssue[]

Defined in

packages/@orbit/records/src/record-validators/record-type-validator.ts:31


validateRelatedRecord

Const validateRelatedRecord(input, options?): undefined | RelatedRecordValidationIssue[]

Parameters

NameType
inputRelatedRecordInput
options?RelatedRecordValidationOptions

Returns

undefined | RelatedRecordValidationIssue[]

Defined in

packages/@orbit/records/src/record-validators/related-record-validator.ts:65