defineBinaryArtifact

import { defineBinaryArtifact } from "@elie-laloum/outpost";

Rôle et comportement

Déclare un contrat nommé et versionné pour des données Uint8Array, copiées à la publication et à la lecture. Lève une erreur si name ou version est vide ou dépasse 1024 caractères.

Exemple complet et règles détaillées.

Paramètres et propriétés

optionsRequis
ArtifactContractOptions
Nom et version du contrat.
options.nameRequis
string
Nom du contrat, non vide et de 1024 caractères au maximum. Une lecture exige le même nom.
options.versionRequis
string
Version du contrat que vous choisissez, non vide et de 1024 caractères au maximum. Une lecture exige la même version : changez-la quand le format change.

Retour

ArtifactContract<Uint8Array<ArrayBufferLike>>

Signature

export declare function defineBinaryArtifact(
  options: ArtifactContractOptions,
): ArtifactContract<Uint8Array>;

Contrats associés

ArtifactContract
ArtifactContractOptions