Skip to Content
SDKvibexArtifact

artifact

Module: vibex/artifact

Artifact Management for VibeX

Provides a simple interface for managing space artifacts (documents, images, and other files) within the VibeX system

Classes

ArtifactManager

View source

Methods:

saveArtifact

View source

Save an artifact to the space

function saveArtifact(spaceId: string, filename: string, content: Buffer | string, metadata?: Partial<ArtifactMetadata>): Promise<ArtifactMetadata>

Parameters:

NameTypeDescription
spaceIdstring
filenamestring
contentBuffer | string
metadataPartial<ArtifactMetadata> (optional)

getArtifact

View source

Get an artifact from the space

function getArtifact(spaceId: string, filename: string): Promise<Buffer | null>

Parameters:

NameTypeDescription
spaceIdstring
filenamestring

listArtifacts

View source

List all artifacts in the space

function listArtifacts(): Promise<ArtifactMetadata[]>

deleteArtifact

View source

Delete an artifact

function deleteArtifact(spaceId: string, filename: string): Promise<boolean>

Parameters:

NameTypeDescription
spaceIdstring
filenamestring


Interfaces

ArtifactMetadata

View source

Properties:

NameTypeDescription
namestring
pathstring
mimeTypestring
sizenumber
createdAtstring
updatedAtstring(optional)
tagsstring[](optional)
descriptionstring(optional)