Function useGraffitiGet

  • useGraffitiGet<Schema extends JSONSchema>(
        locationOrUri: MaybeRefOrGetter<string | GraffitiLocation>,
        schema: MaybeRefOrGetter<Schema>,
        session?: MaybeRefOrGetter<undefined | null | GraffitiSession>,
    ): {
        isPolling: Ref<boolean>;
        poll: () => Promise<void>;
        result: Ref<undefined | null | GraffitiObject<Schema>>;
    }

    The Graffiti.get method as a reactive composable for use in the Vue composition API.

    Its corresponding renderless component is GraffitiGet.

    The arguments of this composable as the same as Graffiti.get, only they can also be Refs or getters. As they change the output will automatically update. Reactivity only triggers when the root array or object changes, not when the elements or properties change. If you need deep reactivity, wrap your argument in a getter.

    Type Parameters

    • Schema extends JSONSchema

    Parameters

    • locationOrUri: MaybeRefOrGetter<string | GraffitiLocation>
    • schema: MaybeRefOrGetter<Schema>
    • Optionalsession: MaybeRefOrGetter<undefined | null | GraffitiSession>

      If the session is undefined, the global session, $graffitiSession, will be used. Otherwise, the provided value will be used.

    Returns {
        isPolling: Ref<boolean>;
        poll: () => Promise<void>;
        result: Ref<undefined | null | GraffitiObject<Schema>>;
    }

Settings

Member Visibility