@graffiti-garden/api
    Preparing search index...

    Interface GraffitiObjectStreamReturn<Schema>Internal

    The output of a GraffitiObjectStream or a GraffitiObjectStreamContinue that allows the stream to be continued from where it left off.

    The continue function preserves the typing of the original stream, where as the cursor string can be serialized for use after a person has closed and reopened an application.

    The continued stream may include tombstones of objects that have been deleted since the original stream was run. See GraffitiObjectStreamContinueTombstone. The continued stream may also return some objects that were already returned by the original stream, depending on how much state the underlying implementation is able to preserve.

    interface GraffitiObjectStreamReturn<Schema extends JSONSchema> {
        continue: () => GraffitiObjectStreamContinue<Schema>;
        cursor: string;
    }

    Type Parameters

    Index

    Properties

    Properties

    Type Declaration

    cursor: string

    A string that can be serialized and stored to resume the stream later. It must be passed to the Graffiti.continueObjectStream method to resume the stream.