Hierarchy

  • SerializedStateManagerV1

Methods

  • This method is intended to be called by consumers, i.e. Feature Apps and Feature Services, on the client to retrieve the serialized state that was created on the server.

    Returns undefined | string

  • This method is intended to be called by consumers, i.e. Feature Apps and Feature Services, on the server to register a callback that serializes their state.

    Parameters

    • serializeState: (() => string)

      A callback that returns the consumer state as a serialized string.

        • (): string
        • Returns string

    Returns void

  • This method is intended to be called by the integrator on the server when the server-side rendering has been completed, to serialize all consumer states. The returned string is encoded, so that it can be safely injected into an HTML document. On the client, this string must be passed unmodified into setSerializedStates where it will be decoded again.

    Returns string

  • This method is intended to be called by the integrator on the client to provide the serialized state to all consumers, i.e. Feature Apps and Feature Services, (via getSerializedState) that serialized their state on the server.

    Parameters

    • serializedStates: string

      The string that was created on the server with serializeStates.

    Returns void

Generated using TypeDoc