nuxt/dist/app/island-hash.d.ts

Nuxt is a free and open-source framework with an intuitive and extendable way to create type-safe, performant and production-grade full-stack web applications and websites with Vue.js.

//#region src/app/island-hash.d.ts
/**
 * Strip Vue scoped-style attributes (`data-v-*`) from island props before hashing
 * or rendering. Scoped-id markers leak in from parent components and are not part
 * of the logical island input.
 *
 * Used before island props are serialized and sent to the island handler.
 *
 * @internal
 */
declare function filterIslandProps(props: Record<string, any> | null | undefined): Record<string, any>;
/**
 * Serialize island props exactly as they will be sent to the island handler, so
 * the client hashes the same string the server receives. Values that JSON
 * drops or rewrites (`undefined`, functions, `NaN`, ...) are removed.
 *
 * @since 4.5.0
 */
declare function serializeIslandProps(props: Record<string, any> | null | undefined): string;
/**
 * Compute the `hashId` segment embedded in an island URL (`/__nuxt_island/<Name>_<hashId>.json`).
 *
 * The hash binds the response to the requested `(name, props, context, source)` tuple, so the
 * server can reject requests whose URL hash does not match the supplied query/body. Use this
 * from island clients if you need to ensure a hash stays in step with Nuxt's implementation.
 *
 * `props` may be passed either as the raw props object or as the JSON string that will be sent
 * over the wire; the two produce the same hash when the round-trip is identity.
 *
 * @since 4.5.0
 */
declare function getIslandHash(input: {
  name: string;
  props: Record<string, any> | string | null | undefined;
  context?: Record<string, any>;
  source?: string;
}): string;
/**
 * @internal
 * @deprecated use `getIslandHash` instead
 */
declare function computeIslandHash(name: string, serializedProps: string, context: Record<string, any>, source: string | undefined): string;
//#endregion
export { computeIslandHash, filterIslandProps, getIslandHash, serializeIslandProps };