tinybase 6.3.0 → 6.4.0-beta.1

package/@types/store/with-schemas/index.d.ts

@@ -2843,6 +2843,7 @@ export type StoreListenerStats = {
  * @see Hello World demos
  * @see Todo App demos
  * @category Store
+ * @essential Creating stores
  * @since v1.0.0
  */
 export interface Store<in out Schemas extends OptionalSchemas> {
@@ -3363,6 +3364,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {}
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v1.0.0
    */
   getRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -3454,6 +3456,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v1.0.0
    */
   getCell<
@@ -3574,6 +3577,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v3.0.0
    */
   getValue<ValueId extends ValueIdFromSchema<Schemas[1]>>(
@@ -4310,6 +4314,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {pets: {fido: {color: 'brown'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   setRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -4386,6 +4391,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {pets: {'0': {species: 'dog'}, '1': {species: 'cat'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   addRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -4526,6 +4532,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {pets: {fido: {species: 'dog'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   setCell<
@@ -4717,6 +4724,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {employees: 3}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v3.0.0
    */
   setValue<ValueId extends ValueIdFromSchema<Schemas[1]>>(
@@ -5572,6 +5580,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {open: true}
    * ```
    * @category Transaction
+   * @essential Setting data
    * @since v1.0.0
    */
   transaction<Return>(
@@ -7551,6 +7560,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v1.0.0
    */
   addRowListener<
@@ -7973,6 +7983,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v1.0.0
    */
   addCellListener<
@@ -8438,6 +8449,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v3.0.0
    */
   addValueListener<ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null>(
@@ -9408,6 +9420,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
  * ```
  * @see The Basics guides
  * @category Creation
+ * @essential Creating stores
  * @since v1.0.0
  */
 export function createStore(): Store<NoSchemas>;

package/@types/synchronizers/index.d.ts

@@ -198,6 +198,7 @@ export type SynchronizerStats = {
  * await synchronizer2.destroy();
  * ```
  * @category Synchronizer
+ * @essential Synchronizing stores
  * @since v5.0.0
  */
 export interface Synchronizer extends Persister<Persists.MergeableStoreOnly> {

package/@types/synchronizers/synchronizer-ws-client/index.d.ts

@@ -148,6 +148,7 @@ export interface WsSynchronizer<WebSocketType extends WebSocketTypes>
  * await server.destroy();
  * ```
  * @category Creation
+ * @essential Synchronizing stores
  * @since v5.0.0
  */
 export function createWsSynchronizer<WebSocketType extends WebSocketTypes>(

package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.ts

@@ -164,6 +164,7 @@ export interface WsSynchronizer<
  * await server.destroy();
  * ```
  * @category Creation
+ * @essential Synchronizing stores
  * @since v5.0.0
  */
 export function createWsSynchronizer<

package/@types/synchronizers/synchronizer-ws-server-durable-object/index.d.ts

@@ -28,6 +28,7 @@ import type {Persister, Persists} from '../../persisters/index.d.ts';
  * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
  * `webSocketClose`) if you further override them.
  * @category Creation
+ * @essential Synchronizing stores
  * @since v5.4.0
  */
 export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {

package/@types/synchronizers/synchronizer-ws-server-durable-object/with-schemas/index.d.ts

@@ -36,6 +36,7 @@ import type {
  * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
  * `webSocketClose`) if you further override them.
  * @category Creation
+ * @essential Synchronizing stores
  * @since v5.4.0
  */
 export class WsServerDurableObject<

package/@types/synchronizers/with-schemas/index.d.ts

@@ -194,6 +194,7 @@ export type SynchronizerStats = {
  * await synchronizer2.destroy();
  * ```
  * @category Synchronizer
+ * @essential Synchronizing stores
  * @since v5.0.0
  */
 export interface Synchronizer<Schemas extends OptionalSchemas>

package/@types/ui-react/index.d.ts

@@ -376,6 +376,7 @@ export type GetId<Parameter> = (parameter: Parameter, store: Store) => Id;
  * // -> '<span>cat</span>'
  * ```
  * @category Store hooks
+ * @essential Using React
  * @since v1.0.0
  */
 export function useCreateStore(
@@ -1910,6 +1911,7 @@ export function useHasRow(
  * // -> '<span>{"color":"brown"}</span>'
  * ```
  * @category Store hooks
+ * @essential Using React
  * @since v1.0.0
  */
 export function useRow(
@@ -2224,6 +2226,7 @@ export function useHasCell(
  * // -> '<span>brown</span>'
  * ```
  * @category Store hooks
+ * @essential Using React
  * @since v1.0.0
  */
 export function useCell(
@@ -2701,6 +2704,7 @@ export function useHasValue(
  * // -> '<span>true</span>'
  * ```
  * @category Store hooks
+ * @essential Using React
  * @since v3.0.0
  */
 export function useValue(
@@ -14343,6 +14347,7 @@ export type ComponentReturnType = ReactElement<any, any> | null;
  * // -> '<span>5,5,2</span>'
  * ```
  * @category Context components
+ * @essential Using React
  * @since v1.0.0
  */
 export function Provider(

package/@types/ui-react/with-schemas/index.d.ts

@@ -471,6 +471,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>cat</span>'
  * ```
  * @category Store hooks
+ * @essential Using React
  * @since v1.0.0
  */
   useCreateStore: (
@@ -2153,6 +2154,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>{"color":"brown"}</span>'
  * ```
  * @category Store hooks
+ * @essential Using React
  * @since v1.0.0
  */
   useRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -2502,6 +2504,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>brown</span>'
  * ```
  * @category Store hooks
+ * @essential Using React
  * @since v1.0.0
  */
   useCell: <
@@ -3020,6 +3023,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>true</span>'
  * ```
  * @category Store hooks
+ * @essential Using React
  * @since v3.0.0
  */
   useValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
@@ -14425,6 +14429,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<span>5,5,2</span>'
  * ```
  * @category Context components
+ * @essential Using React
  * @since v1.0.0
  */
   Provider: (

package/@types/ui-react-inspector/index.d.ts

@@ -74,6 +74,7 @@ export type InspectorProps = {
  * // -> '<aside id="tinybaseInspector">'
  * ```
  * @category Development components
+ * @essential Using React
  * @since v5.0.0
  */
 export function Inspector(props: InspectorProps): ComponentReturnType;

package/@types/ui-react-inspector/with-schemas/index.d.ts

@@ -1979,6 +1979,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<aside id="tinybaseInspector">'
  * ```
  * @category Development components
+ * @essential Using React
  * @since v5.0.0
  */
   Inspector: (props: InspectorProps) => ComponentReturnType;