Skip to main content

IEntry Interface

Cache entry. Identifies file that this entry belongs to, and type of content stored in it.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/odsp-driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IEntry

Properties

Property Alerts Type Description
key Alpha string Identifies individual entry for a given file and type. Each file can have multiple cache entries associated with it. This property identifies a particular instance of entry. For example, for blobs it will be unique ID of the blob in a file. For batch of ops, it can be starting op sequence number. For types that have only one entry (like snapshots), it will be empty string.
type Alpha CacheContentType Identifies type of entry for a given file. Each file can have multiple types of entries associated with it. For example, it can be snapshot, blob, ops, etc.

Property Details

key

Identifies individual entry for a given file and type. Each file can have multiple cache entries associated with it. This property identifies a particular instance of entry. For example, for blobs it will be unique ID of the blob in a file. For batch of ops, it can be starting op sequence number. For types that have only one entry (like snapshots), it will be empty string.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

key: string;

Type: string

type

Identifies type of entry for a given file. Each file can have multiple types of entries associated with it. For example, it can be snapshot, blob, ops, etc.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

type: CacheContentType;

Type: CacheContentType