Type alias YDocProviderProps

YDocProviderProps: {
    children: ReactNode;
    clientToken: ClientToken;
    setQueryParam?: string;

Props to the YDocProvider component.

Type declaration

  • children: ReactNode

    The children to render.

  • clientToken: ClientToken

    Response of a getConnectionKey call, passed from server to client.

  • Optional setQueryParam?: string

    If set to a string, the URL query parameter with this name will be set to the doc id from connectionKey.