From 2fba5191f3d9a9008532ec705cfa4dd8403c9c32 Mon Sep 17 00:00:00 2001 From: pvditto <123380273+pvditto@users.noreply.github.com> Date: Wed, 25 Sep 2024 08:50:01 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20getditto?= =?UTF-8?q?/react-ditto@ea02759553c5fe2dd7f2f2a10481cecbac288ada=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- functions/DittoLazyProvider.html | 2 +- functions/DittoProvider.html | 2 +- functions/useCollections.html | 2 +- functions/useConnectionStatus.html | 2 +- functions/useDitto.html | 2 +- functions/useDittoContext.html | 2 +- functions/useLazyPendingCursorOperation.html | 2 +- functions/useLazyPendingIDSpecificOperation.html | 2 +- functions/useMutations.html | 2 +- functions/useOfflinePlaygroundIdentity.html | 2 +- functions/useOnlineIdentity.html | 2 +- functions/useOnlinePlaygroundIdentity.html | 2 +- functions/usePendingCursorOperation.html | 2 +- functions/usePendingIDSpecificOperation.html | 2 +- functions/useRemotePeers.html | 2 +- interfaces/CollectionsQueryParams.html | 8 ++++---- interfaces/ConnectionStatusParams.html | 6 +++--- .../CreateOfflinePlaygroundIdentityParams.html | 4 ++-- interfaces/CreateOnlineIdentityParams.html | 4 ++-- .../CreateOnlinePlaygroundIdentityParams.html | 4 ++-- interfaces/DittoContextProps.html | 8 ++++---- interfaces/DittoHash.html | 2 +- interfaces/DittoHookProps.html | 4 ++-- interfaces/DittoLazyProviderProps.html | 6 +++--- interfaces/DittoProviderProps.html | 6 +++--- interfaces/LazyPendingCursorOperationReturn.html | 16 ++++++++-------- .../LazyPendingIDSpecificOperationReturn.html | 16 ++++++++-------- interfaces/LiveQueryParams.html | 16 ++++++++-------- interfaces/PendingCursorOperationReturn.html | 16 ++++++++-------- interfaces/PendingIDSpecificOperationReturn.html | 14 +++++++------- interfaces/ProviderState.html | 6 +++--- interfaces/RemoveByIDParams.html | 4 ++-- interfaces/RemoveParams.html | 4 ++-- interfaces/UpdateByIDParams.html | 6 +++--- interfaces/UpdateParams.html | 8 ++++---- interfaces/UpsertParams.html | 4 ++-- interfaces/UseMutationParams.html | 6 +++--- interfaces/UsePeersParams.html | 4 ++-- .../UsePendingIDSpecificOperationParams.html | 10 +++++----- interfaces/useOnlineIdentityProps.html | 8 ++++---- interfaces/useOnlinePlaygroundIdentityProps.html | 4 ++-- types/RegisterDitto.html | 2 +- types/RemoveByIDFunction.html | 2 +- types/RemoveFunction.html | 2 +- types/RenderFunction.html | 2 +- types/UnregisterDitto.html | 2 +- types/UpdateByIDFunction.html | 2 +- types/UpdateFunction.html | 2 +- types/UpsertFunction.html | 2 +- variables/DittoContext.html | 2 +- 50 files changed, 121 insertions(+), 121 deletions(-) diff --git a/functions/DittoLazyProvider.html b/functions/DittoLazyProvider.html index 781f50d..b9dcaad 100644 --- a/functions/DittoLazyProvider.html +++ b/functions/DittoLazyProvider.html @@ -1,7 +1,7 @@ DittoLazyProvider | @dittolive/react-ditto

Function DittoLazyProvider

  • DittoLazyProvider(props, context?): ReactElement<any, any>

  • Implements a lazy Ditto provider which is initially mounted without any Ditto instances. Child components are then responsible for invoking the provider's load function to create a Ditto instance on demand when it is needed.

    Parameters

    Returns ReactElement<any, any>

    A function that needs to return a React.Element

    -

Properties

contextTypes? +

Properties

contextTypes? defaultProps? displayName? propTypes? diff --git a/functions/DittoProvider.html b/functions/DittoProvider.html index 7ca5e9f..471ecb5 100644 --- a/functions/DittoProvider.html +++ b/functions/DittoProvider.html @@ -2,7 +2,7 @@ provider is mounted through a call to the setup function, which then returns one or multiple Ditto instances.

Parameters

Returns ReactElement<any, any>

A function that needs to return a React.Element

-

Properties

contextTypes? +

Properties

contextTypes? defaultProps? displayName? propTypes? diff --git a/functions/useCollections.html b/functions/useCollections.html index d815465..86e2e2d 100644 --- a/functions/useCollections.html +++ b/functions/useCollections.html @@ -8,4 +8,4 @@ limit: 2 })

Parameters

Returns {
    collectionsEvent: CollectionsEvent | undefined;
    ditto: Ditto;
    documents: Collection[];
    liveQuery: LiveQuery | undefined;
    subscription: Subscription | undefined;
}

  • collectionsEvent: CollectionsEvent | undefined
  • ditto: Ditto
  • documents: Collection[]
  • liveQuery: LiveQuery | undefined
  • subscription: Subscription | undefined

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns {
    collectionsEvent: CollectionsEvent | undefined;
    ditto: Ditto;
    documents: Collection[];
    liveQuery: LiveQuery | undefined;
    subscription: Subscription | undefined;
}

  • collectionsEvent: CollectionsEvent | undefined
  • ditto: Ditto
  • documents: Collection[]
  • liveQuery: LiveQuery | undefined
  • subscription: Subscription | undefined

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useConnectionStatus.html b/functions/useConnectionStatus.html index c1a8b0d..cfc93b2 100644 --- a/functions/useConnectionStatus.html +++ b/functions/useConnectionStatus.html @@ -1,3 +1,3 @@ useConnectionStatus | @dittolive/react-ditto

Function useConnectionStatus

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useDitto.html b/functions/useDitto.html index e97686e..fc54ea5 100644 --- a/functions/useDitto.html +++ b/functions/useDitto.html @@ -1 +1 @@ -useDitto | @dittolive/react-ditto

Function useDitto

Settings

Member Visibility

Theme

\ No newline at end of file +useDitto | @dittolive/react-ditto

Function useDitto

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useDittoContext.html b/functions/useDittoContext.html index 0114de4..c260bb4 100644 --- a/functions/useDittoContext.html +++ b/functions/useDittoContext.html @@ -1 +1 @@ -useDittoContext | @dittolive/react-ditto

Function useDittoContext

Settings

Member Visibility

Theme

\ No newline at end of file +useDittoContext | @dittolive/react-ditto

Function useDittoContext

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useLazyPendingCursorOperation.html b/functions/useLazyPendingCursorOperation.html index df0ea0f..7b40332 100644 --- a/functions/useLazyPendingCursorOperation.html +++ b/functions/useLazyPendingCursorOperation.html @@ -2,4 +2,4 @@

Returns LazyPendingCursorOperationReturn

LazyPendingCursorOperationReturn

Example

 const { documents, exec } = useLazyPendingCursorOperation<Webhook>()

 const handleSomeEvent = () => {
   exec({
    path: myPath,
    offset: 0,
    collection: 'collection'
    sort: {
      propertyPath: 'createdAt',
      direction: 'descending' as SortDirection,
    },
  })
 }
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useLazyPendingIDSpecificOperation.html b/functions/useLazyPendingIDSpecificOperation.html index 2eda2e9..1b02de7 100644 --- a/functions/useLazyPendingIDSpecificOperation.html +++ b/functions/useLazyPendingIDSpecificOperation.html @@ -3,4 +3,4 @@

Returns LazyPendingIDSpecificOperationReturn

LazyPendingIDSpecificOperationReturn

Example

 const { document, exec } = useLazyPendingIDSpecificOperation<Webhook>()


 const handleSomeEvent = () => {
   exec({
    path: myPath,
    collection: 'collection'
    _id: new DocumentID("some_id")
  })
 }
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useMutations.html b/functions/useMutations.html index 050e3da..43c2690 100644 --- a/functions/useMutations.html +++ b/functions/useMutations.html @@ -1 +1 @@ -useMutations | @dittolive/react-ditto

Function useMutations

Settings

Member Visibility

Theme

\ No newline at end of file +useMutations | @dittolive/react-ditto

Function useMutations

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useOfflinePlaygroundIdentity.html b/functions/useOfflinePlaygroundIdentity.html index 7863c67..5a2b867 100644 --- a/functions/useOfflinePlaygroundIdentity.html +++ b/functions/useOfflinePlaygroundIdentity.html @@ -1,4 +1,4 @@ useOfflinePlaygroundIdentity | @dittolive/react-ditto

Function useOfflinePlaygroundIdentity

  • useOfflinePlaygroundIdentity(): {
        create: ((params) => IdentityOfflinePlayground);
    }

  • Returns {
        create: ((params) => IdentityOfflinePlayground);
    }

    Example

    const { create } = useOfflinePlaygroundIdentity();

    const myIdentity = create({appId: uuid(), siteID: 1234});
    const ditto = new Ditto(myIdentity, '/path');

    A hook for creating Development Ditto identity objects.

    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useOnlineIdentity.html b/functions/useOnlineIdentity.html index ff389c4..489c120 100644 --- a/functions/useOnlineIdentity.html +++ b/functions/useOnlineIdentity.html @@ -3,4 +3,4 @@

A hook for creating OnlineDitto identity objects. For creating OnlinePlayground identities, use {@link useOnlinePlaygroundIdentity} instead.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useOnlinePlaygroundIdentity.html b/functions/useOnlinePlaygroundIdentity.html index 21293d3..ffdf32b 100644 --- a/functions/useOnlinePlaygroundIdentity.html +++ b/functions/useOnlinePlaygroundIdentity.html @@ -2,4 +2,4 @@

Example

const { create } = useOnlinePlaygroundIdentity();

const myIdentity = create({appId: uuid(), token: 'my-token'});
const ditto = new Ditto(myIdentity, '/path');

A hook for creating OnlinePlayground Ditto identity objects.

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/usePendingCursorOperation.html b/functions/usePendingCursorOperation.html index eadd9d7..285e939 100644 --- a/functions/usePendingCursorOperation.html +++ b/functions/usePendingCursorOperation.html @@ -2,4 +2,4 @@

Parameters

Returns PendingCursorOperationReturn

Example

 const { documents } = usePendingCursorOperation<Webhook>({
    path: myPath,
    offset: 0,
    collection: 'collection'
    sort: {
      propertyPath: 'createdAt',
      direction: 'descending' as SortDirection,
    },
  })
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/usePendingIDSpecificOperation.html b/functions/usePendingIDSpecificOperation.html index 266a40d..baad375 100644 --- a/functions/usePendingIDSpecificOperation.html +++ b/functions/usePendingIDSpecificOperation.html @@ -4,4 +4,4 @@

Returns PendingIDSpecificOperationReturn

PendingIDSpecificOperationReturn

Example

 const { document } = usePendingIDSpecificOperation<Webhook>({
    path: myPath,
    collection: 'collection'
    _id: new DocumentID("some_id")
  })
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/useRemotePeers.html b/functions/useRemotePeers.html index dac886c..94866b7 100644 --- a/functions/useRemotePeers.html +++ b/functions/useRemotePeers.html @@ -1,3 +1,3 @@ useRemotePeers | @dittolive/react-ditto

Function useRemotePeers

  • useRemotePeers(params?): {
        ditto: Ditto;
        remotePeers: Peer[];
    }

  • Returns all the connected peers for this client.

    Parameters

    Returns {
        ditto: Ditto;
        remotePeers: Peer[];
    }

    • ditto: Ditto
    • remotePeers: Peer[]

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns {
    ditto: Ditto;
    remotePeers: Peer[];
}

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/interfaces/CollectionsQueryParams.html b/interfaces/CollectionsQueryParams.html index d259eed..dd0aeb5 100644 --- a/interfaces/CollectionsQueryParams.html +++ b/interfaces/CollectionsQueryParams.html @@ -1,9 +1,9 @@ -CollectionsQueryParams | @dittolive/react-ditto

Interface CollectionsQueryParams

interface CollectionsQueryParams {
    limit?: number;
    path?: string;
    sort?: {
        direction?: SortDirection;
        propertyPath: "name" | "_id";
    };
}

Properties

limit? +CollectionsQueryParams | @dittolive/react-ditto

Interface CollectionsQueryParams

interface CollectionsQueryParams {
    limit?: number;
    path?: string;
    sort?: {
        direction?: SortDirection;
        propertyPath: "name" | "_id";
    };
}

Properties

limit? path? sort?

Properties

Optional limit

limit?: number

An optional number to limit the results of the collections query. If you omit this value, the query will return all values

-

Optional path

path?: string

The path of the Ditto string. If you omit this, it will fetch the first registered Ditto value.

-

Optional sort

sort?: {
    direction?: SortDirection;
    propertyPath: "name" | "_id";
}

Type declaration

  • Optional direction?: SortDirection
  • propertyPath: "name" | "_id"

    An optional sort parameter for your collections query. Allows sorting collections using the _id and names fields, in ascending +

Optional path

path?: string

The path of the Ditto string. If you omit this, it will fetch the first registered Ditto value.

+

Optional sort

sort?: {
    direction?: SortDirection;
    propertyPath: "name" | "_id";
}

Type declaration

  • Optional direction?: SortDirection
  • propertyPath: "name" | "_id"

    An optional sort parameter for your collections query. Allows sorting collections using the _id and names fields, in ascending or descending order:

    {
      propertyPath: "name",
      direction: "ascending"
    }
    @@ -11,4 +11,4 @@ 
    {
      propertyPath: "name",
      direction: "descending"
    }

    For more information on the query string syntax refer to https://docs.ditto.live/concepts/querying

    -

Settings

Member Visibility

Theme

On This Page

limitpathsort
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

limitpathsort
\ No newline at end of file diff --git a/interfaces/ConnectionStatusParams.html b/interfaces/ConnectionStatusParams.html index 2d79c63..5b890e2 100644 --- a/interfaces/ConnectionStatusParams.html +++ b/interfaces/ConnectionStatusParams.html @@ -1,5 +1,5 @@ -ConnectionStatusParams | @dittolive/react-ditto

Interface ConnectionStatusParams

interface ConnectionStatusParams {
    forTransport: ConnectionType;
    path?: string;
}

Properties

forTransport +ConnectionStatusParams | @dittolive/react-ditto

Interface ConnectionStatusParams

interface ConnectionStatusParams {
    forTransport: ConnectionType;
    path?: string;
}

Properties

forTransport path?

Properties

forTransport

forTransport: ConnectionType

Transport for which the connection status is retrieved.

-

Optional path

path?: string

The path of the Ditto string. If you omit this, it will fetch the first registered Ditto value.

-

Settings

Member Visibility

Theme

On This Page

forTransportpath
\ No newline at end of file +

Optional path

path?: string

The path of the Ditto string. If you omit this, it will fetch the first registered Ditto value.

+

Settings

Member Visibility

Theme

On This Page

forTransportpath
\ No newline at end of file diff --git a/interfaces/CreateOfflinePlaygroundIdentityParams.html b/interfaces/CreateOfflinePlaygroundIdentityParams.html index d86c859..cb2d8b7 100644 --- a/interfaces/CreateOfflinePlaygroundIdentityParams.html +++ b/interfaces/CreateOfflinePlaygroundIdentityParams.html @@ -1,3 +1,3 @@ -CreateOfflinePlaygroundIdentityParams | @dittolive/react-ditto

Interface CreateOfflinePlaygroundIdentityParams

interface CreateOfflinePlaygroundIdentityParams {
    appID: string;
    siteID: number | bigint;
}

Properties

appID +CreateOfflinePlaygroundIdentityParams | @dittolive/react-ditto

Interface CreateOfflinePlaygroundIdentityParams

interface CreateOfflinePlaygroundIdentityParams {
    appID: string;
    siteID: number | bigint;
}

Properties

appID siteID -

Properties

appID

appID: string

siteID

siteID: number | bigint

Settings

Member Visibility

Theme

On This Page

appIDsiteID
\ No newline at end of file +

Properties

appID

appID: string

siteID

siteID: number | bigint

Settings

Member Visibility

Theme

On This Page

appIDsiteID
\ No newline at end of file diff --git a/interfaces/CreateOnlineIdentityParams.html b/interfaces/CreateOnlineIdentityParams.html index 1ebba2e..f037445 100644 --- a/interfaces/CreateOnlineIdentityParams.html +++ b/interfaces/CreateOnlineIdentityParams.html @@ -1,4 +1,4 @@ -CreateOnlineIdentityParams | @dittolive/react-ditto

Interface CreateOnlineIdentityParams

interface CreateOnlineIdentityParams {
    appID: string;
    customAuthURL?: string;
    enableDittoCloudSync?: boolean;
}

Properties

appID +CreateOnlineIdentityParams | @dittolive/react-ditto

Interface CreateOnlineIdentityParams

interface CreateOnlineIdentityParams {
    appID: string;
    customAuthURL?: string;
    enableDittoCloudSync?: boolean;
}

Properties

appID customAuthURL? enableDittoCloudSync? -

Properties

appID

appID: string

Optional customAuthURL

customAuthURL?: string

Optional enableDittoCloudSync

enableDittoCloudSync?: boolean

Settings

Member Visibility

Theme

On This Page

appIDcustomAuthURLenableDittoCloudSync
\ No newline at end of file +

Properties

appID

appID: string

Optional customAuthURL

customAuthURL?: string

Optional enableDittoCloudSync

enableDittoCloudSync?: boolean

Settings

Member Visibility

Theme

On This Page

appIDcustomAuthURLenableDittoCloudSync
\ No newline at end of file diff --git a/interfaces/CreateOnlinePlaygroundIdentityParams.html b/interfaces/CreateOnlinePlaygroundIdentityParams.html index 062fff1..f2f4055 100644 --- a/interfaces/CreateOnlinePlaygroundIdentityParams.html +++ b/interfaces/CreateOnlinePlaygroundIdentityParams.html @@ -1,5 +1,5 @@ -CreateOnlinePlaygroundIdentityParams | @dittolive/react-ditto

Interface CreateOnlinePlaygroundIdentityParams

interface CreateOnlinePlaygroundIdentityParams {
    appID: string;
    customAuthURL?: string;
    enableDittoCloudSync?: boolean;
    token: string;
}

Properties

appID +CreateOnlinePlaygroundIdentityParams | @dittolive/react-ditto

Interface CreateOnlinePlaygroundIdentityParams

interface CreateOnlinePlaygroundIdentityParams {
    appID: string;
    customAuthURL?: string;
    enableDittoCloudSync?: boolean;
    token: string;
}

Properties

appID customAuthURL? enableDittoCloudSync? token -

Properties

appID

appID: string

Optional customAuthURL

customAuthURL?: string

Optional enableDittoCloudSync

enableDittoCloudSync?: boolean

token

token: string

Settings

Member Visibility

Theme

On This Page

appIDcustomAuthURLenableDittoCloudSynctoken
\ No newline at end of file +

Properties

appID

appID: string

Optional customAuthURL

customAuthURL?: string

Optional enableDittoCloudSync

enableDittoCloudSync?: boolean

token

token: string

Settings

Member Visibility

Theme

On This Page

appIDcustomAuthURLenableDittoCloudSynctoken
\ No newline at end of file diff --git a/interfaces/DittoContextProps.html b/interfaces/DittoContextProps.html index f438b5c..dbf036a 100644 --- a/interfaces/DittoContextProps.html +++ b/interfaces/DittoContextProps.html @@ -1,8 +1,8 @@ -DittoContextProps | @dittolive/react-ditto

Interface DittoContextProps

interface DittoContextProps {
    dittoHash: DittoHash;
    isLazy: boolean;
    load: ((appPath) => Promise<void | Ditto>);
    registerDitto?: RegisterDitto;
    unregisterDitto?: UnregisterDitto;
}

Properties

dittoHash +DittoContextProps | @dittolive/react-ditto

Interface DittoContextProps

interface DittoContextProps {
    dittoHash: DittoHash;
    isLazy: boolean;
    load: ((appPath) => Promise<void | Ditto>);
    registerDitto?: RegisterDitto;
    unregisterDitto?: UnregisterDitto;
}

Properties

dittoHash isLazy load registerDitto? unregisterDitto? -

Properties

dittoHash

dittoHash: DittoHash

isLazy

isLazy: boolean

True if the context is initialized through a DittoLazyProvider.

-

load

load: ((appPath) => Promise<void | Ditto>)

Provided only by the DittoLazyProvider. Will fail on the non-lazy DittoContext provider.

-

Type declaration

    • (appPath): Promise<void | Ditto>

    • Parameters

      • appPath: string

      Returns Promise<void | Ditto>

Optional registerDitto

registerDitto?: RegisterDitto

Optional unregisterDitto

unregisterDitto?: UnregisterDitto

Settings

Member Visibility

Theme

On This Page

dittoHashisLazyloadregisterDittounregisterDitto
\ No newline at end of file +

Properties

dittoHash

dittoHash: DittoHash

isLazy

isLazy: boolean

True if the context is initialized through a DittoLazyProvider.

+

load

load: ((appPath) => Promise<void | Ditto>)

Provided only by the DittoLazyProvider. Will fail on the non-lazy DittoContext provider.

+

Type declaration

    • (appPath): Promise<void | Ditto>

    • Parameters

      • appPath: string

      Returns Promise<void | Ditto>

Optional registerDitto

registerDitto?: RegisterDitto

Optional unregisterDitto

unregisterDitto?: UnregisterDitto

Settings

Member Visibility

Theme

On This Page

dittoHashisLazyloadregisterDittounregisterDitto
\ No newline at end of file diff --git a/interfaces/DittoHash.html b/interfaces/DittoHash.html index 01aaa4a..b0ed03b 100644 --- a/interfaces/DittoHash.html +++ b/interfaces/DittoHash.html @@ -1 +1 @@ -DittoHash | @dittolive/react-ditto

Interface DittoHash

interface DittoHash {
    [key: string]: Ditto;
}

Indexable

[key: string]: Ditto

Settings

Member Visibility

Theme

\ No newline at end of file +DittoHash | @dittolive/react-ditto

Interface DittoHash

interface DittoHash {
    [key: string]: Ditto;
}

Indexable

[key: string]: Ditto

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/interfaces/DittoHookProps.html b/interfaces/DittoHookProps.html index 0b24c03..7dea918 100644 --- a/interfaces/DittoHookProps.html +++ b/interfaces/DittoHookProps.html @@ -1,4 +1,4 @@ -DittoHookProps | @dittolive/react-ditto

Interface DittoHookProps

interface DittoHookProps {
    ditto: Ditto;
    error: Error;
    loading: boolean;
}

Properties

ditto +DittoHookProps | @dittolive/react-ditto

Interface DittoHookProps

interface DittoHookProps {
    ditto: Ditto;
    error: Error;
    loading: boolean;
}

Properties

ditto error loading -

Properties

ditto

ditto: Ditto

error

error: Error

loading

loading: boolean

Settings

Member Visibility

Theme

On This Page

dittoerrorloading
\ No newline at end of file +

Properties

ditto

ditto: Ditto

error

error: Error

loading

loading: boolean

Settings

Member Visibility

Theme

On This Page

dittoerrorloading
\ No newline at end of file diff --git a/interfaces/DittoLazyProviderProps.html b/interfaces/DittoLazyProviderProps.html index a8384b3..4c6f6e6 100644 --- a/interfaces/DittoLazyProviderProps.html +++ b/interfaces/DittoLazyProviderProps.html @@ -1,8 +1,8 @@ -DittoLazyProviderProps | @dittolive/react-ditto

Interface DittoLazyProviderProps

interface DittoLazyProviderProps {
    children?: RenderFunction;
    initOptions?: InitOptions;
    render?: RenderFunction;
    setup: ((appPath) => Promise<Ditto>);
}

Properties

children? +DittoLazyProviderProps | @dittolive/react-ditto

Interface DittoLazyProviderProps

interface DittoLazyProviderProps {
    children?: RenderFunction;
    initOptions?: InitOptions;
    render?: RenderFunction;
    setup: ((appPath) => Promise<Ditto>);
}

Properties

children? initOptions? render? setup -

Properties

Optional children

children?: RenderFunction

Optional initOptions

initOptions?: InitOptions

Optional render

render?: RenderFunction

setup

setup: ((appPath) => Promise<Ditto>)

This function is called whenever a child component uses a Ditto instance through the useDitto hook +

Properties

Optional children

children?: RenderFunction

Optional initOptions

initOptions?: InitOptions

Optional render

render?: RenderFunction

setup

setup: ((appPath) => Promise<Ditto>)

This function is called whenever a child component uses a Ditto instance through the useDitto hook and the instance needs to be created.

Type declaration

    • (appPath): Promise<Ditto>

    • Parameters

      • appPath: string

      Returns Promise<Ditto>

Returns

A Ditto instance initialized on the given path

-

Settings

Member Visibility

Theme

On This Page

childreninitOptionsrendersetup
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

childreninitOptionsrendersetup
\ No newline at end of file diff --git a/interfaces/DittoProviderProps.html b/interfaces/DittoProviderProps.html index 5c014da..715427c 100644 --- a/interfaces/DittoProviderProps.html +++ b/interfaces/DittoProviderProps.html @@ -1,8 +1,8 @@ -DittoProviderProps | @dittolive/react-ditto

Interface DittoProviderProps

interface DittoProviderProps {
    children?: RenderFunction;
    initOptions?: InitOptions;
    render?: RenderFunction;
    setup: (() => Ditto | Ditto[] | Promise<Ditto | Ditto[]>);
}

Properties

children? +DittoProviderProps | @dittolive/react-ditto

Interface DittoProviderProps

interface DittoProviderProps {
    children?: RenderFunction;
    initOptions?: InitOptions;
    render?: RenderFunction;
    setup: (() => Ditto | Ditto[] | Promise<Ditto | Ditto[]>);
}

Properties

children? initOptions? render? setup -

Properties

Optional children

children?: RenderFunction

Optional initOptions

initOptions?: InitOptions

Optional render

render?: RenderFunction

setup

setup: (() => Ditto | Ditto[] | Promise<Ditto | Ditto[]>)

This function is called when the DittoProvider initialized the Ditto module. +

Properties

Optional children

children?: RenderFunction

Optional initOptions

initOptions?: InitOptions

Optional render

render?: RenderFunction

setup

setup: (() => Ditto | Ditto[] | Promise<Ditto | Ditto[]>)

This function is called when the DittoProvider initialized the Ditto module. Use this function to bootstrap the Ditto instance to the provider.

Returns a single Ditto instance or an array of instances.

-

Type declaration

    • (): Ditto | Ditto[] | Promise<Ditto | Ditto[]>

    • Returns Ditto | Ditto[] | Promise<Ditto | Ditto[]>

Settings

Member Visibility

Theme

On This Page

childreninitOptionsrendersetup
\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

On This Page

childreninitOptionsrendersetup
\ No newline at end of file diff --git a/interfaces/LazyPendingCursorOperationReturn.html b/interfaces/LazyPendingCursorOperationReturn.html index 47ab1ea..766807b 100644 --- a/interfaces/LazyPendingCursorOperationReturn.html +++ b/interfaces/LazyPendingCursorOperationReturn.html @@ -1,4 +1,4 @@ -LazyPendingCursorOperationReturn | @dittolive/react-ditto

Interface LazyPendingCursorOperationReturn

interface LazyPendingCursorOperationReturn {
    collection: Collection;
    ditto: Ditto;
    documents: Document[];
    exec: ((params) => Promise<void>);
    liveQuery: LiveQuery;
    liveQueryEvent: LiveQueryEvent;
    subscription: Subscription;
}

Properties

collection +LazyPendingCursorOperationReturn | @dittolive/react-ditto

Interface LazyPendingCursorOperationReturn

interface LazyPendingCursorOperationReturn {
    collection: Collection;
    ditto: Ditto;
    documents: Document[];
    exec: ((params) => Promise<void>);
    liveQuery: LiveQuery;
    liveQueryEvent: LiveQueryEvent;
    subscription: Subscription;
}

Properties

collection ditto documents exec @@ -6,10 +6,10 @@ liveQueryEvent subscription

Properties

collection

collection: Collection

Current Ditto collection instance.

-

ditto

ditto: Ditto

The initialized Ditto instance if one could be found for the provided path.

-

documents

documents: Document[]

The set of documents found for the current query.

-

exec

exec: ((params) => Promise<void>)

Function used to trigger a query on a collection

-

Type declaration

    • (params): Promise<void>

    • Parameters

      Returns Promise<void>

liveQuery

liveQuery: LiveQuery

Currently active live query.

-

liveQueryEvent

liveQueryEvent: LiveQueryEvent

The last LiveQueryEvent received by the query observer.

-

subscription

subscription: Subscription

Currently active subscription.

-

Settings

Member Visibility

Theme

On This Page

collectiondittodocumentsexecliveQueryliveQueryEventsubscription
\ No newline at end of file +

ditto

ditto: Ditto

The initialized Ditto instance if one could be found for the provided path.

+

documents

documents: Document[]

The set of documents found for the current query.

+

exec

exec: ((params) => Promise<void>)

Function used to trigger a query on a collection

+

Type declaration

    • (params): Promise<void>

    • Parameters

      Returns Promise<void>

liveQuery

liveQuery: LiveQuery

Currently active live query.

+

liveQueryEvent

liveQueryEvent: LiveQueryEvent

The last LiveQueryEvent received by the query observer.

+

subscription

subscription: Subscription

Currently active subscription.

+

Settings

Member Visibility

Theme

On This Page

collectiondittodocumentsexecliveQueryliveQueryEventsubscription
\ No newline at end of file diff --git a/interfaces/LazyPendingIDSpecificOperationReturn.html b/interfaces/LazyPendingIDSpecificOperationReturn.html index 2d26dfd..e0a5c4b 100644 --- a/interfaces/LazyPendingIDSpecificOperationReturn.html +++ b/interfaces/LazyPendingIDSpecificOperationReturn.html @@ -1,4 +1,4 @@ -LazyPendingIDSpecificOperationReturn | @dittolive/react-ditto

Interface LazyPendingIDSpecificOperationReturn

interface LazyPendingIDSpecificOperationReturn {
    collection: Collection;
    ditto: Ditto;
    document: Document;
    event?: SingleDocumentLiveQueryEvent;
    exec: ((params) => Promise<void>);
    liveQuery: LiveQuery;
    subscription: Subscription;
}

Properties

collection +LazyPendingIDSpecificOperationReturn | @dittolive/react-ditto

Interface LazyPendingIDSpecificOperationReturn

interface LazyPendingIDSpecificOperationReturn {
    collection: Collection;
    ditto: Ditto;
    document: Document;
    event?: SingleDocumentLiveQueryEvent;
    exec: ((params) => Promise<void>);
    liveQuery: LiveQuery;
    subscription: Subscription;
}

Properties

collection ditto document event? @@ -6,10 +6,10 @@ liveQuery subscription

Properties

collection

collection: Collection

Current Ditto collection instance.

-

ditto

ditto: Ditto

The initialized Ditto instance if one could be found for the provided path.

-

document

document: Document

The document found for the current query.

-

Optional event

event?: SingleDocumentLiveQueryEvent

The last SingleDocumentLiveQueryEvent received by the query observer.

-

exec

exec: ((params) => Promise<void>)

Function used to trigger a query on a collection

-

Type declaration

liveQuery

liveQuery: LiveQuery

Currently active live query.

-

subscription

subscription: Subscription

Currently active live query.

-

Settings

Member Visibility

Theme

On This Page

collectiondittodocumenteventexecliveQuerysubscription
\ No newline at end of file +

ditto

ditto: Ditto

The initialized Ditto instance if one could be found for the provided path.

+

document

document: Document

The document found for the current query.

+

Optional event

event?: SingleDocumentLiveQueryEvent

The last SingleDocumentLiveQueryEvent received by the query observer.

+

exec

exec: ((params) => Promise<void>)

Function used to trigger a query on a collection

+

Type declaration

liveQuery

liveQuery: LiveQuery

Currently active live query.

+

subscription

subscription: Subscription

Currently active live query.

+

Settings

Member Visibility

Theme

On This Page

collectiondittodocumenteventexecliveQuerysubscription
\ No newline at end of file diff --git a/interfaces/LiveQueryParams.html b/interfaces/LiveQueryParams.html index 4425f87..52a88f2 100644 --- a/interfaces/LiveQueryParams.html +++ b/interfaces/LiveQueryParams.html @@ -1,4 +1,4 @@ -LiveQueryParams | @dittolive/react-ditto

Interface LiveQueryParams

interface LiveQueryParams {
    args?: QueryArguments;
    collection: string;
    limit?: number;
    localOnly?: boolean;
    offset?: number;
    path?: string;
    query?: string;
    sort?: {
        direction?: SortDirection;
        propertyPath: string;
    };
}

Properties

args? +LiveQueryParams | @dittolive/react-ditto

Interface LiveQueryParams

interface LiveQueryParams {
    args?: QueryArguments;
    collection: string;
    limit?: number;
    localOnly?: boolean;
    offset?: number;
    path?: string;
    query?: string;
    sort?: {
        direction?: SortDirection;
        propertyPath: string;
    };
}

Properties

args? collection limit? localOnly? @@ -9,18 +9,18 @@

Properties

Optional args

args?: QueryArguments

Optional arguments that will interpolate the values into the query string. For example, if your query string is

"color == $args.color && mileage >= $args.mileage"
```. You can provide an args dictionary like:
```js
{ color: "red", mileage: "1200" }
-

collection

collection: string

Optional limit

limit?: number

An optional number to limit the results of the query. If you omit this value, the query will return all values

-

Optional localOnly

localOnly?: boolean

When true the query will only on local data mutations and will not rely on replication.

-

Optional offset

offset?: number

An optional number to use as an offset of the results of the query. If you omit this value, an offset of 0 is assumed.

-

Optional path

path?: string

The path of the Ditto string. If you omit this, it will fetch the first registered Ditto value.

-

Optional query

query?: string

A Ditto query string. For more information on the query string syntax refer to https://docs.ditto.live/concepts/querying +

collection

collection: string

Optional limit

limit?: number

An optional number to limit the results of the query. If you omit this value, the query will return all values

+

Optional localOnly

localOnly?: boolean

When true the query will only on local data mutations and will not rely on replication.

+

Optional offset

offset?: number

An optional number to use as an offset of the results of the query. If you omit this value, an offset of 0 is assumed.

+

Optional path

path?: string

The path of the Ditto string. If you omit this, it will fetch the first registered Ditto value.

+

Optional query

query?: string

A Ditto query string. For more information on the query string syntax refer to https://docs.ditto.live/concepts/querying For example to query for a color property equal to red use: color == 'red'

-

Optional sort

sort?: {
    direction?: SortDirection;
    propertyPath: string;
}

Type declaration

  • Optional direction?: SortDirection
  • propertyPath: string

    An optional sort parameter for your query. For example, if you want to sort with ascending values on a specific field like "createdOn" use:

    +

Optional sort

sort?: {
    direction?: SortDirection;
    propertyPath: string;
}

Type declaration

  • Optional direction?: SortDirection
  • propertyPath: string

    An optional sort parameter for your query. For example, if you want to sort with ascending values on a specific field like "createdOn" use:

    {
      propertyPath: "createdOn",
      direction: "ascending"
    }

    For descending values use:

    {
      propertyPath: "createdOn",
      direction: "ascending"
    }

    For more information on the query string syntax refer to https://docs.ditto.live/concepts/querying

    -

Settings

Member Visibility

Theme

On This Page

argscollectionlimitlocalOnlyoffsetpathquerysort
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

argscollectionlimitlocalOnlyoffsetpathquerysort
\ No newline at end of file diff --git a/interfaces/PendingCursorOperationReturn.html b/interfaces/PendingCursorOperationReturn.html index 761c916..f2f5584 100644 --- a/interfaces/PendingCursorOperationReturn.html +++ b/interfaces/PendingCursorOperationReturn.html @@ -1,4 +1,4 @@ -PendingCursorOperationReturn | @dittolive/react-ditto

Interface PendingCursorOperationReturn

interface PendingCursorOperationReturn {
    collection: Collection;
    ditto: Ditto;
    documents: Document[];
    liveQuery: LiveQuery;
    liveQueryEvent: LiveQueryEvent;
    reset: (() => void);
    subscription: Subscription;
}

Properties

collection +PendingCursorOperationReturn | @dittolive/react-ditto

Interface PendingCursorOperationReturn

interface PendingCursorOperationReturn {
    collection: Collection;
    ditto: Ditto;
    documents: Document[];
    liveQuery: LiveQuery;
    liveQueryEvent: LiveQueryEvent;
    reset: (() => void);
    subscription: Subscription;
}

Properties

collection ditto documents liveQuery @@ -6,10 +6,10 @@ reset subscription

Properties

collection

collection: Collection

Current Ditto collection instance.

-

ditto

ditto: Ditto

The initialized Ditto instance if one could be found for the provided path.

-

documents

documents: Document[]

The set of documents found for the current query.

-

liveQuery

liveQuery: LiveQuery

Currently active live query.

-

liveQueryEvent

liveQueryEvent: LiveQueryEvent

The last LiveQueryEvent received by the query observer.

-

reset

reset: (() => void)

A function used to stop the currect live query and create a new one using the current input params.

-

Type declaration

    • (): void

    • Returns void

subscription

subscription: Subscription

Currently active subscription.

-

Settings

Member Visibility

Theme

On This Page

collectiondittodocumentsliveQueryliveQueryEventresetsubscription
\ No newline at end of file +

ditto

ditto: Ditto

The initialized Ditto instance if one could be found for the provided path.

+

documents

documents: Document[]

The set of documents found for the current query.

+

liveQuery

liveQuery: LiveQuery

Currently active live query.

+

liveQueryEvent

liveQueryEvent: LiveQueryEvent

The last LiveQueryEvent received by the query observer.

+

reset

reset: (() => void)

A function used to stop the currect live query and create a new one using the current input params.

+

Type declaration

    • (): void

    • Returns void

subscription

subscription: Subscription

Currently active subscription.

+

Settings

Member Visibility

Theme

On This Page

collectiondittodocumentsliveQueryliveQueryEventresetsubscription
\ No newline at end of file diff --git a/interfaces/PendingIDSpecificOperationReturn.html b/interfaces/PendingIDSpecificOperationReturn.html index 2dccc16..a06064e 100644 --- a/interfaces/PendingIDSpecificOperationReturn.html +++ b/interfaces/PendingIDSpecificOperationReturn.html @@ -1,13 +1,13 @@ -PendingIDSpecificOperationReturn | @dittolive/react-ditto

Interface PendingIDSpecificOperationReturn

interface PendingIDSpecificOperationReturn {
    collection: Collection;
    ditto: Ditto;
    document: Document;
    event?: SingleDocumentLiveQueryEvent;
    liveQuery: LiveQuery;
    subscription: Subscription;
}

Properties

collection +PendingIDSpecificOperationReturn | @dittolive/react-ditto

Interface PendingIDSpecificOperationReturn

interface PendingIDSpecificOperationReturn {
    collection: Collection;
    ditto: Ditto;
    document: Document;
    event?: SingleDocumentLiveQueryEvent;
    liveQuery: LiveQuery;
    subscription: Subscription;
}

Properties

collection ditto document event? liveQuery subscription

Properties

collection

collection: Collection

Current Ditto collection instance.

-

ditto

ditto: Ditto

The initialized Ditto instance if one could be found for the provided path.

-

document

document: Document

The document found for the current query.

-

Optional event

event?: SingleDocumentLiveQueryEvent

The last SingleDocumentLiveQueryEvent received by the query observer.

-

liveQuery

liveQuery: LiveQuery

Currently active live query.

-

subscription

subscription: Subscription

Currently active subscription.

-

Settings

Member Visibility

Theme

On This Page

collectiondittodocumenteventliveQuerysubscription
\ No newline at end of file +

ditto

ditto: Ditto

The initialized Ditto instance if one could be found for the provided path.

+

document

document: Document

The document found for the current query.

+

Optional event

event?: SingleDocumentLiveQueryEvent

The last SingleDocumentLiveQueryEvent received by the query observer.

+

liveQuery

liveQuery: LiveQuery

Currently active live query.

+

subscription

subscription: Subscription

Currently active subscription.

+

Settings

Member Visibility

Theme

On This Page

collectiondittodocumenteventliveQuerysubscription
\ No newline at end of file diff --git a/interfaces/ProviderState.html b/interfaces/ProviderState.html index a48c2db..980deb9 100644 --- a/interfaces/ProviderState.html +++ b/interfaces/ProviderState.html @@ -1,6 +1,6 @@ ProviderState | @dittolive/react-ditto

Interface ProviderState

A description of the DittoProvider's loading state.

-
interface ProviderState {
    error: Error;
    loading: boolean;
}

Properties

error +
interface ProviderState {
    error: Error;
    loading: boolean;
}

Properties

error loading

Properties

error

error: Error

If there was an error loading the ditto.wasm file, the error will have an Error

-

loading

loading: boolean

If the Provider is loading the ditto.wasm file.

-

Settings

Member Visibility

Theme

On This Page

errorloading
\ No newline at end of file +

loading

loading: boolean

If the Provider is loading the ditto.wasm file.

+

Settings

Member Visibility

Theme

On This Page

errorloading
\ No newline at end of file diff --git a/interfaces/RemoveByIDParams.html b/interfaces/RemoveByIDParams.html index 34242d1..af0d3ca 100644 --- a/interfaces/RemoveByIDParams.html +++ b/interfaces/RemoveByIDParams.html @@ -1,2 +1,2 @@ -RemoveByIDParams | @dittolive/react-ditto

Interface RemoveByIDParams

interface RemoveByIDParams {
    _id?: DocumentID;
}

Properties

_id? -

Properties

Optional _id

_id?: DocumentID

Settings

Member Visibility

Theme

On This Page

_id
\ No newline at end of file +RemoveByIDParams | @dittolive/react-ditto

Interface RemoveByIDParams

interface RemoveByIDParams {
    _id?: DocumentID;
}

Properties

_id? +

Properties

Optional _id

_id?: DocumentID

Settings

Member Visibility

Theme

On This Page

_id
\ No newline at end of file diff --git a/interfaces/RemoveParams.html b/interfaces/RemoveParams.html index b4fd627..13f24d8 100644 --- a/interfaces/RemoveParams.html +++ b/interfaces/RemoveParams.html @@ -1,3 +1,3 @@ -RemoveParams | @dittolive/react-ditto

Interface RemoveParams

interface RemoveParams {
    args?: QueryArguments;
    query?: string;
}

Properties

args? +RemoveParams | @dittolive/react-ditto

Interface RemoveParams

interface RemoveParams {
    args?: QueryArguments;
    query?: string;
}

Properties

args? query? -

Properties

Optional args

args?: QueryArguments

Optional query

query?: string

Settings

Member Visibility

Theme

On This Page

argsquery
\ No newline at end of file +

Properties

Optional args

args?: QueryArguments

Optional query

query?: string

Settings

Member Visibility

Theme

On This Page

argsquery
\ No newline at end of file diff --git a/interfaces/UpdateByIDParams.html b/interfaces/UpdateByIDParams.html index 01acef4..f354f9e 100644 --- a/interfaces/UpdateByIDParams.html +++ b/interfaces/UpdateByIDParams.html @@ -1,5 +1,5 @@ -UpdateByIDParams | @dittolive/react-ditto

Interface UpdateByIDParams

interface UpdateByIDParams {
    _id: any;
    updateClosure: ((mutableDocument) => void);
}

Properties

_id +UpdateByIDParams | @dittolive/react-ditto

Interface UpdateByIDParams

interface UpdateByIDParams {
    _id: any;
    updateClosure: ((mutableDocument) => void);
}

Properties

_id updateClosure

Properties

_id

_id: any

The _id of the document to remove

-

updateClosure

updateClosure: ((mutableDocument) => void)

The update function to perform on the specified document

-

Type declaration

    • (mutableDocument): void

    • Parameters

      • mutableDocument: MutableDocument

      Returns void

Settings

Member Visibility

Theme

On This Page

_idupdateClosure
\ No newline at end of file +

updateClosure

updateClosure: ((mutableDocument) => void)

The update function to perform on the specified document

+

Type declaration

    • (mutableDocument): void

    • Parameters

      • mutableDocument: MutableDocument

      Returns void

Settings

Member Visibility

Theme

On This Page

_idupdateClosure
\ No newline at end of file diff --git a/interfaces/UpdateParams.html b/interfaces/UpdateParams.html index e475e2f..499ce75 100644 --- a/interfaces/UpdateParams.html +++ b/interfaces/UpdateParams.html @@ -1,8 +1,8 @@ -UpdateParams | @dittolive/react-ditto

Interface UpdateParams

interface UpdateParams {
    args?: QueryArguments;
    query?: string;
    updateClosure: ((mutableDocuments) => void);
}

Properties

args? +UpdateParams | @dittolive/react-ditto

Interface UpdateParams

interface UpdateParams {
    args?: QueryArguments;
    query?: string;
    updateClosure: ((mutableDocuments) => void);
}

Properties

args? query? updateClosure

Properties

Optional args

args?: QueryArguments

Arguments to use with the query

-

Optional query

query?: string

A Ditto query that specifies the documents to update. If this is omitted, then the updateClosure will +

Optional query

query?: string

A Ditto query that specifies the documents to update. If this is omitted, then the updateClosure will apply to all documents.

-

updateClosure

updateClosure: ((mutableDocuments) => void)

A function used to update all the documents

-

Type declaration

    • (mutableDocuments): void

    • Parameters

      • mutableDocuments: MutableDocument[]

      Returns void

Settings

Member Visibility

Theme

On This Page

argsqueryupdateClosure
\ No newline at end of file +

updateClosure

updateClosure: ((mutableDocuments) => void)

A function used to update all the documents

+

Type declaration

    • (mutableDocuments): void

    • Parameters

      • mutableDocuments: MutableDocument[]

      Returns void

Settings

Member Visibility

Theme

On This Page

argsqueryupdateClosure
\ No newline at end of file diff --git a/interfaces/UpsertParams.html b/interfaces/UpsertParams.html index c728f44..0e24775 100644 --- a/interfaces/UpsertParams.html +++ b/interfaces/UpsertParams.html @@ -1,3 +1,3 @@ -UpsertParams | @dittolive/react-ditto

Interface UpsertParams

interface UpsertParams {
    upsertOptions?: UpsertOptions;
    value: DocumentValue;
}

Properties

upsertOptions? +UpsertParams | @dittolive/react-ditto

Interface UpsertParams

interface UpsertParams {
    upsertOptions?: UpsertOptions;
    value: DocumentValue;
}

Properties

upsertOptions? value -

Properties

Optional upsertOptions

upsertOptions?: UpsertOptions

value

value: DocumentValue

Settings

Member Visibility

Theme

On This Page

upsertOptionsvalue
\ No newline at end of file +

Properties

Optional upsertOptions

upsertOptions?: UpsertOptions

value

value: DocumentValue

Settings

Member Visibility

Theme

On This Page

upsertOptionsvalue
\ No newline at end of file diff --git a/interfaces/UseMutationParams.html b/interfaces/UseMutationParams.html index 4b65f3f..9e77f5e 100644 --- a/interfaces/UseMutationParams.html +++ b/interfaces/UseMutationParams.html @@ -1,5 +1,5 @@ -UseMutationParams | @dittolive/react-ditto

Interface UseMutationParams

interface UseMutationParams {
    collection: string;
    path?: string;
}

Properties

collection +UseMutationParams | @dittolive/react-ditto

Interface UseMutationParams

interface UseMutationParams {
    collection: string;
    path?: string;
}

Properties

collection path?

Properties

collection

collection: string

The name of the collection

-

Optional path

path?: string

An optional path of the ditto instance that you'd like to use

-

Settings

Member Visibility

Theme

On This Page

collectionpath
\ No newline at end of file +

Optional path

path?: string

An optional path of the ditto instance that you'd like to use

+

Settings

Member Visibility

Theme

On This Page

collectionpath
\ No newline at end of file diff --git a/interfaces/UsePeersParams.html b/interfaces/UsePeersParams.html index 8797889..fcb9080 100644 --- a/interfaces/UsePeersParams.html +++ b/interfaces/UsePeersParams.html @@ -1,3 +1,3 @@ -UsePeersParams | @dittolive/react-ditto

Interface UsePeersParams

interface UsePeersParams {
    path?: string;
}

Properties

path? +UsePeersParams | @dittolive/react-ditto

Interface UsePeersParams

interface UsePeersParams {
    path?: string;
}

Properties

path?

Properties

Optional path

path?: string

Ditto Path

-

Settings

Member Visibility

Theme

On This Page

path
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

path
\ No newline at end of file diff --git a/interfaces/UsePendingIDSpecificOperationParams.html b/interfaces/UsePendingIDSpecificOperationParams.html index dfd2214..1597f8b 100644 --- a/interfaces/UsePendingIDSpecificOperationParams.html +++ b/interfaces/UsePendingIDSpecificOperationParams.html @@ -1,9 +1,9 @@ -UsePendingIDSpecificOperationParams | @dittolive/react-ditto

Interface UsePendingIDSpecificOperationParams

interface UsePendingIDSpecificOperationParams {
    _id: any;
    collection: string;
    localOnly?: boolean;
    path?: string;
}

Properties

_id +UsePendingIDSpecificOperationParams | @dittolive/react-ditto

Interface UsePendingIDSpecificOperationParams

interface UsePendingIDSpecificOperationParams {
    _id: any;
    collection: string;
    localOnly?: boolean;
    path?: string;
}

Properties

_id collection localOnly? path?

Properties

_id

_id: any

The _id of the document to query

-

collection

collection: string

The name of the collection to query

-

Optional localOnly

localOnly?: boolean

When true the query will only on local data mutations and will not rely on replication.

-

Optional path

path?: string

The path

-

Settings

Member Visibility

Theme

On This Page

_idcollectionlocalOnlypath
\ No newline at end of file +

collection

collection: string

The name of the collection to query

+

Optional localOnly

localOnly?: boolean

When true the query will only on local data mutations and will not rely on replication.

+

Optional path

path?: string

The path

+

Settings

Member Visibility

Theme

On This Page

_idcollectionlocalOnlypath
\ No newline at end of file diff --git a/interfaces/useOnlineIdentityProps.html b/interfaces/useOnlineIdentityProps.html index 7d57819..080f0c7 100644 --- a/interfaces/useOnlineIdentityProps.html +++ b/interfaces/useOnlineIdentityProps.html @@ -1,9 +1,9 @@ -useOnlineIdentityProps | @dittolive/react-ditto

Interface useOnlineIdentityProps

interface useOnlineIdentityProps {
    create: ((params, path) => IdentityOnlineWithAuthentication);
    getAuthenticationRequired: ((forPath) => boolean);
    getTokenExpiresInSeconds: ((forPath) => number);
}

Properties

create +useOnlineIdentityProps | @dittolive/react-ditto

Interface useOnlineIdentityProps

interface useOnlineIdentityProps {
    create: ((params, path) => IdentityOnlineWithAuthentication);
    getAuthenticationRequired: ((forPath) => boolean);
    getTokenExpiresInSeconds: ((forPath) => number);
}

Properties

create getAuthenticationRequired getTokenExpiresInSeconds

Properties

create

create: ((params, path) => IdentityOnlineWithAuthentication)

Function used for creating a new online identity. Will save an internal reference to the identity inside of the hook in order to manage the authentication state for the identity.

-

Type declaration

    • (params, path): IdentityOnlineWithAuthentication

    • Parameters

      Returns IdentityOnlineWithAuthentication

getAuthenticationRequired

getAuthenticationRequired: ((forPath) => boolean)

Retrieves the authentication required state for any of the identities created with the hook.

-

Type declaration

    • (forPath): boolean

    • Parameters

      • forPath: string

      Returns boolean

getTokenExpiresInSeconds

getTokenExpiresInSeconds: ((forPath) => number)

Retrieves the token expiration time for an identity if one has been notified by the SDK, for any identity created with +

Type declaration

    • (params, path): IdentityOnlineWithAuthentication

    • Parameters

      Returns IdentityOnlineWithAuthentication

getAuthenticationRequired

getAuthenticationRequired: ((forPath) => boolean)

Retrieves the authentication required state for any of the identities created with the hook.

+

Type declaration

    • (forPath): boolean

    • Parameters

      • forPath: string

      Returns boolean

getTokenExpiresInSeconds

getTokenExpiresInSeconds: ((forPath) => number)

Retrieves the token expiration time for an identity if one has been notified by the SDK, for any identity created with the hook.

-

Type declaration

    • (forPath): number

    • Parameters

      • forPath: string

      Returns number

Settings

Member Visibility

Theme

On This Page

creategetAuthenticationRequiredgetTokenExpiresInSeconds
\ No newline at end of file +

Type declaration

    • (forPath): number

    • Parameters

      • forPath: string

      Returns number

Settings

Member Visibility

Theme

On This Page

creategetAuthenticationRequiredgetTokenExpiresInSeconds
\ No newline at end of file diff --git a/interfaces/useOnlinePlaygroundIdentityProps.html b/interfaces/useOnlinePlaygroundIdentityProps.html index 97e9aa7..965c324 100644 --- a/interfaces/useOnlinePlaygroundIdentityProps.html +++ b/interfaces/useOnlinePlaygroundIdentityProps.html @@ -1,3 +1,3 @@ -useOnlinePlaygroundIdentityProps | @dittolive/react-ditto

Interface useOnlinePlaygroundIdentityProps

interface useOnlinePlaygroundIdentityProps {
    create: ((params) => IdentityOnlinePlayground);
}

Properties

create +useOnlinePlaygroundIdentityProps | @dittolive/react-ditto

Interface useOnlinePlaygroundIdentityProps

interface useOnlinePlaygroundIdentityProps {
    create: ((params) => IdentityOnlinePlayground);
}

Properties

create

Properties

create

create: ((params) => IdentityOnlinePlayground)

Function used for creating a new online playground identity.

-

Type declaration

Settings

Member Visibility

Theme

On This Page

create
\ No newline at end of file +

Type declaration

Settings

Member Visibility

Theme

On This Page

create
\ No newline at end of file diff --git a/types/RegisterDitto.html b/types/RegisterDitto.html index 75b5317..6511e28 100644 --- a/types/RegisterDitto.html +++ b/types/RegisterDitto.html @@ -1 +1 @@ -RegisterDitto | @dittolive/react-ditto

Type alias RegisterDitto

RegisterDitto: ((ditto) => void)

Type declaration

    • (ditto): void

    • Parameters

      • ditto: Ditto

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +RegisterDitto | @dittolive/react-ditto

Type alias RegisterDitto

RegisterDitto: ((ditto) => void)

Type declaration

    • (ditto): void

    • Parameters

      • ditto: Ditto

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/RemoveByIDFunction.html b/types/RemoveByIDFunction.html index 6fb455d..7d4b152 100644 --- a/types/RemoveByIDFunction.html +++ b/types/RemoveByIDFunction.html @@ -1 +1 @@ -RemoveByIDFunction | @dittolive/react-ditto

Type alias RemoveByIDFunction

RemoveByIDFunction: ((params) => Promise<boolean>)

Type declaration

    • (params): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

Settings

Member Visibility

Theme

\ No newline at end of file +RemoveByIDFunction | @dittolive/react-ditto

Type alias RemoveByIDFunction

RemoveByIDFunction: ((params) => Promise<boolean>)

Type declaration

    • (params): Promise<boolean>

    • Parameters

      Returns Promise<boolean>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/RemoveFunction.html b/types/RemoveFunction.html index 6a95a95..8b06de0 100644 --- a/types/RemoveFunction.html +++ b/types/RemoveFunction.html @@ -1 +1 @@ -RemoveFunction | @dittolive/react-ditto

Type alias RemoveFunction

RemoveFunction: ((params) => Promise<DocumentID[]>)

Type declaration

    • (params): Promise<DocumentID[]>

    • Parameters

      Returns Promise<DocumentID[]>

Settings

Member Visibility

Theme

\ No newline at end of file +RemoveFunction | @dittolive/react-ditto

Type alias RemoveFunction

RemoveFunction: ((params) => Promise<DocumentID[]>)

Type declaration

    • (params): Promise<DocumentID[]>

    • Parameters

      Returns Promise<DocumentID[]>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/RenderFunction.html b/types/RenderFunction.html index a576d81..4bc937f 100644 --- a/types/RenderFunction.html +++ b/types/RenderFunction.html @@ -1 +1 @@ -RenderFunction | @dittolive/react-ditto

Type alias RenderFunction

RenderFunction: ((providerState) => ReactNode)

Type declaration

    • (providerState): ReactNode

    • Parameters

      Returns ReactNode

Settings

Member Visibility

Theme

\ No newline at end of file +RenderFunction | @dittolive/react-ditto

Type alias RenderFunction

RenderFunction: ((providerState) => ReactNode)

Type declaration

    • (providerState): ReactNode

    • Parameters

      Returns ReactNode

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/UnregisterDitto.html b/types/UnregisterDitto.html index ac8b928..53e2841 100644 --- a/types/UnregisterDitto.html +++ b/types/UnregisterDitto.html @@ -1 +1 @@ -UnregisterDitto | @dittolive/react-ditto

Type alias UnregisterDitto

UnregisterDitto: ((persistenceDirectory) => void)

Type declaration

    • (persistenceDirectory): void

    • Parameters

      • persistenceDirectory: string

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +UnregisterDitto | @dittolive/react-ditto

Type alias UnregisterDitto

UnregisterDitto: ((persistenceDirectory) => void)

Type declaration

    • (persistenceDirectory): void

    • Parameters

      • persistenceDirectory: string

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/UpdateByIDFunction.html b/types/UpdateByIDFunction.html index e035c36..cba8eb6 100644 --- a/types/UpdateByIDFunction.html +++ b/types/UpdateByIDFunction.html @@ -1 +1 @@ -UpdateByIDFunction | @dittolive/react-ditto

Type alias UpdateByIDFunction

UpdateByIDFunction: ((params) => Promise<UpdateResult[]>)

Type declaration

    • (params): Promise<UpdateResult[]>

    • Parameters

      Returns Promise<UpdateResult[]>

Settings

Member Visibility

Theme

\ No newline at end of file +UpdateByIDFunction | @dittolive/react-ditto

Type alias UpdateByIDFunction

UpdateByIDFunction: ((params) => Promise<UpdateResult[]>)

Type declaration

    • (params): Promise<UpdateResult[]>

    • Parameters

      Returns Promise<UpdateResult[]>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/UpdateFunction.html b/types/UpdateFunction.html index b582fa4..4614213 100644 --- a/types/UpdateFunction.html +++ b/types/UpdateFunction.html @@ -1 +1 @@ -UpdateFunction | @dittolive/react-ditto

Type alias UpdateFunction

UpdateFunction: ((params) => Promise<UpdateResultsMap>)

Type declaration

    • (params): Promise<UpdateResultsMap>

    • Parameters

      Returns Promise<UpdateResultsMap>

Settings

Member Visibility

Theme

\ No newline at end of file +UpdateFunction | @dittolive/react-ditto

Type alias UpdateFunction

UpdateFunction: ((params) => Promise<UpdateResultsMap>)

Type declaration

    • (params): Promise<UpdateResultsMap>

    • Parameters

      Returns Promise<UpdateResultsMap>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/UpsertFunction.html b/types/UpsertFunction.html index e8bd936..c06eab1 100644 --- a/types/UpsertFunction.html +++ b/types/UpsertFunction.html @@ -1 +1 @@ -UpsertFunction | @dittolive/react-ditto

Type alias UpsertFunction

UpsertFunction: ((params) => Promise<DocumentID>)

Type declaration

    • (params): Promise<DocumentID>

    • Parameters

      Returns Promise<DocumentID>

Settings

Member Visibility

Theme

\ No newline at end of file +UpsertFunction | @dittolive/react-ditto

Type alias UpsertFunction

UpsertFunction: ((params) => Promise<DocumentID>)

Type declaration

    • (params): Promise<DocumentID>

    • Parameters

      Returns Promise<DocumentID>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/DittoContext.html b/variables/DittoContext.html index e156548..5255a88 100644 --- a/variables/DittoContext.html +++ b/variables/DittoContext.html @@ -1 +1 @@ -DittoContext | @dittolive/react-ditto

Variable DittoContextConst

DittoContext: Context<DittoContextProps> = ...

Settings

Member Visibility

Theme

\ No newline at end of file +DittoContext | @dittolive/react-ditto

Variable DittoContextConst

DittoContext: Context<DittoContextProps> = ...

Settings

Member Visibility

Theme

\ No newline at end of file