Collection<T>

A collection is a class that contains the DataStore, and exposes methods to interact with it.

Collection:Select()

LuauTypeScript

Collection:Select(
    key: string
): (T, Error?)

public function Select(
    key: string
): [T, Error | undefined];

Parameters:

• key string — Unique key for the requested data.

Returns:

• T — Found value in the DataStore, or CollectionOptions.Default if an error occurs.
• Error? — An error value or nil if succeeded.

Description:

• Uses DataStore:GetAsync() to fetch the data from the DataStore.
  • Retries CollectionOptions.MaxRetries times with a CollectionOptions.RetryDelaySeconds delay if the pcall() has resulted in a failure.
• Uses CollectionOptions.Default to set the default value if the key does not exist yet.
• Uses CollectionOptions.Migrations to migrate data of previous versions.
• Uses CollectionOptions.Validate function to validate the data. Forcefully returns nil if the validation fails.

Collection:Update()

LuauTypeScript

Collection:Update(
    key: string,
    data: T,
    userIds: { number }
): Error?

public function Update(
    key: string,
    data: T,
    userIds: number[]
): Error | undefined;

Parameters:

• key string — Unique key for the requested data.

Returns:

• Error? — An error value or nil if succeeded.

Description:

• Uses CollectionOptions.Validate function to validate the given data. Rejects the update if the given data has failed validation.
• Uses DataStore:UpdateAsync() to fetch the data from the DataStore, reject the new update if DataStore contains a newer version, and set the new value if it has verified that it's newer.
  • Retries CollectionOptions.MaxRetries times with a CollectionOptions.RetryDelaySeconds delay if the pcall() has resulted in a failure.