Constructors
constructor
- new BlossomClient(server, signer?): BlossomClient
Parameters
- server: string | URL
Optional
signer: Signer
Methods
deleteBlob
- deleteBlob(hash, auth?): Promise<string>
Returns Promise<string>
getBlob
- getBlob(hash, auth?): Promise<Blob>
Returns Promise<Blob>
getDeleteAuth
- getDeleteAuth(hash, message?, expiration?): Promise<SignedEvent>
Parameters
- hash: string
Optional
message: stringOptional
expiration: number
getGetAuth
- getGetAuth(message, serverOrHash, expiration?): Promise<SignedEvent>
Parameters
- message: string
- serverOrHash: string
Optional
expiration: number
getListAuth
- getListAuth(message?, expiration?): Promise<SignedEvent>
Parameters
Optional
message: stringOptional
expiration: number
getMirrorAuth
- getMirrorAuth(sha256, message?, expiration?): Promise<SignedEvent>
Parameters
- sha256: string
Optional
message: stringOptional
expiration: number
getUploadAuth
- getUploadAuth(file, message?, expiration?): Promise<SignedEvent>
Parameters
- file: UploadType
Optional
message: stringOptional
expiration: number
hasBlob
- hasBlob(hash): Promise<boolean>
Returns Promise<boolean>
listBlobs
- listBlobs(pubkey, opts?, auth?): Promise<BlobDescriptor[]>
Parameters
- pubkey: string
Optional
opts: {
since?: number;
until?: number;
}Optional
since?: number
Optional
until?: number
- auth: boolean | SignedEvent = false
mirrorBlob
- mirrorBlob(sha256, url, auth?): Promise<BlobDescriptor>
Parameters
- sha256: string
- url: string | URL
- auth: boolean | SignedEvent = true
Static
createUploadAuth
- createUploadAuth(sha256, signer, message?, expiration?): Promise<SignedEvent>
Parameters
- sha256: string | string[]
- signer: Signer
- message: string = "Upload Blob"
- expiration: number = ...
Static
deleteBlob
- deleteBlob(server, hash, auth?): Promise<string>
Returns Promise<string>
Static
encodeAuthorizationHeader
- encodeAuthorizationHeader(event): string
Returns string
Static
getBlob
- getBlob(server, hash, auth?): Promise<Blob>
Returns Promise<Blob>
Static
getDeleteAuth
- getDeleteAuth(hash, signer, message?, expiration?): Promise<SignedEvent>
Parameters
- hash: string | string[]
- signer: Signer
- message: string = "Delete Blob"
- expiration: number = ...
Static
getFileSha256
- getFileSha256(file): Promise<string>
Returns Promise<string>
Static
getGetAuth
- getGetAuth(signer, message, serverOrHash, expiration?): Promise<SignedEvent>
Parameters
- signer: Signer
- message: string
- serverOrHash: string | string[]
- expiration: number = ...
Static
getListAuth
- getListAuth(signer, message?, expiration?): Promise<SignedEvent>
Parameters
- signer: Signer
- message: string = "List Blobs"
- expiration: number = ...
Static
getUploadAuth
- getUploadAuth(file, signer, message?, expiration?): Promise<SignedEvent>
Parameters
- file: UploadType
- signer: Signer
- message: string = "Upload Blob"
- expiration: number = ...
Static
hasBlob
- hasBlob(server, hash): Promise<boolean>
Returns Promise<boolean>
Static
listBlobs
- listBlobs(server, pubkey, opts?, auth?): Promise<BlobDescriptor[]>
Parameters
- server: ServerType
- pubkey: string
Optional
opts: {
since?: number;
until?: number;
}Optional
since?: number
Optional
until?: number
Optional
auth: SignedEvent
Creates an upload auth event