Class BlossomClient

Constructors

constructor

new BlossomClient(server, signer?): BlossomClient
Parameters
- server: string | URL
- Optional signer: Signer
Returns BlossomClient
- Defined in src/client.ts:31

Properties

`Optional` payment

payment?: PaymentHandlers<URL>

server

server: URL

`Optional` signer

signer?: Signer

`Static` createDeleteAuth

createDeleteAuth: ((signer, blobs, options?) => Promise<SignedEvent>) = createDeleteAuth

Type declaration

- (signer, blobs, options?): Promise<SignedEvent>
- Creates a "delete" auth event for a specific hash
  Parameters
  - signer: Signer
  - blobs: string | UploadType | string[] | UploadType[]
  - Optional options: DeleteAuthOptions
  Returns Promise<SignedEvent>

`Static` createGetAuth

createGetAuth: ((signer, serverOrHash, options?) => Promise<SignedEvent>) = createDownloadAuth

Type declaration

- (signer, serverOrHash, options?): Promise<SignedEvent>
- Creates a GET auth event
  Parameters
  - signer: Signer
  - serverOrHash: string | UploadType | string[] | UploadType[]
  - Optional options: DownloadAuthOptions
  Returns Promise<SignedEvent>

`Static` createListAuth

createListAuth: ((signer, options?) => Promise<SignedEvent>) = createListAuth

Type declaration

- (signer, options?): Promise<SignedEvent>
- Creates a list auth event
  Parameters
  - signer: Signer
  - Optional options: ListAuthOptions
  Returns Promise<SignedEvent>

`Static` createUploadAuth

createUploadAuth: ((signer, blobs, options?) => Promise<SignedEvent>) = createUploadAuth

Type declaration

- (signer, blobs, options?): Promise<SignedEvent>
- Creates an upload or media upload auth event
  Parameters
  - signer: Signer
  - blobs: string | UploadType | string[] | UploadType[]
  - Optional options: UploadAuthOptions
  Returns Promise<SignedEvent>

`Static` deleteBlob

deleteBlob: (<S>(server, hash, opts?) => Promise<boolean>) = deleteBlob

Type declaration

- <S>(server, hash, opts?): Promise<boolean>
- Deletes a blob to a server
  Type Parameters
  - S extends ServerType
  Parameters
  - server: S
  - hash: string
  - Optional opts: DeleteOptions<S>
  Returns Promise<boolean>

`Static` downloadBlob

downloadBlob: (<S>(server, hash, opts?) => Promise<Response>) = downloadBlob

Type declaration

- <S>(server, hash, opts?): Promise<Response>
- Downloads a blob from a server and returns the Response
  Type Parameters
  - S extends ServerType
  Parameters
  - server: S
  - hash: string
  - Optional opts: DownloadOptions<S>
  Returns Promise<Response>

`Static` encodeAuthorizationHeader

encodeAuthorizationHeader: ((event) => string) = encodeAuthorizationHeader

Type declaration

- (event): string
- Encodes an auth event into a nostr authorization header
  Parameters
  - event: SignedEvent
  Returns string

`Static` getFileSha256

getFileSha256: ((blob) => string | Promise<string>) = getBlobSha256

Type declaration

- (blob): string | Promise<string>
- gets or calculates the sha2456 of a Blob
  Parameters
  - blob: UploadType
  Returns string | Promise<string>

`Static` listBlobs

listBlobs: (<S>(server, pubkey, opts?) => Promise<BlobDescriptor[]>) = listBlobs

Type declaration

- <S>(server, pubkey, opts?): Promise<BlobDescriptor[]>
- Mirrors a blob to a server
  Type Parameters
  - S extends ServerType
  Parameters
  - server: S
  - pubkey: string
  - Optional opts: ListOptions<S>
  Returns Promise<BlobDescriptor[]>

`Static` mirrorBlob

mirrorBlob: (<S>(server, blob, opts?) => Promise<BlobDescriptor>) = mirrorBlob

Type declaration

- <S>(server, blob, opts?): Promise<BlobDescriptor>
- Mirrors a blob to a server
  Type Parameters
  - S extends ServerType
  Parameters
  - server: S
  - blob: BlobDescriptor
  - Optional opts: MirrorOptions<S>
  Returns Promise<BlobDescriptor>

`Static` uploadBlob

uploadBlob: (<S, B>(server, blob, opts?) => Promise<BlobDescriptor>) = uploadBlob

Type declaration

- <S, B>(server, blob, opts?): Promise<BlobDescriptor>
- Upload a blob to a server, handles payment and auth
  Type Parameters
  - S extends ServerType
  - B extends UploadType
  Parameters
  - server: S
  - blob: B
  - Optional opts: UploadOptions<S, B>
  Returns Promise<BlobDescriptor>

`Static` uploadMedia

uploadMedia: (<S, B>(server, blob, opts?) => Promise<BlobDescriptor>) = uploadMedia

Type declaration

- <S, B>(server, blob, opts?): Promise<BlobDescriptor>
- Upload a media blob to a server using the /media endpoint, handles payment and auth
  Type Parameters
  - S extends ServerType
  - B extends UploadType
  Parameters
  - server: S
  - blob: B
  - Optional opts: UploadMediaOptions<S, B>
  Returns Promise<BlobDescriptor>

Methods

createDeleteAuth

createDeleteAuth(blob, options?): Promise<SignedEvent>
Parameters
- blob: string | UploadType
- Optional options: DeleteAuthOptions
Returns Promise<SignedEvent>
- Defined in src/client.ts:197

createDownloadAuth

createDownloadAuth(hash, options?): Promise<SignedEvent>
Parameters
- hash: string
- Optional options: DownloadAuthOptions
Returns Promise<SignedEvent>
- Defined in src/client.ts:57

createListAuth

createListAuth(options?): Promise<SignedEvent>
Parameters
- Optional options: ListAuthOptions
Returns Promise<SignedEvent>
- Defined in src/client.ts:171

createMediaAuth

createMediaAuth(blob, options?): Promise<SignedEvent>
Parameters
- blob: string | UploadType
- Optional options: Omit<UploadAuthOptions, "type">
Returns Promise<SignedEvent>
- Defined in src/client.ts:137

createMirrorAuth

createMirrorAuth(blob, options?): Promise<SignedEvent>
Parameters
- blob: string | BlobDescriptor
- Optional options: MirrorAuthOptions
Returns Promise<SignedEvent>
- Defined in src/client.ts:111

createUploadAuth

createUploadAuth(blob, options?): Promise<SignedEvent>
Parameters
- blob: string | UploadType
- Optional options: UploadAuthOptions
Returns Promise<SignedEvent>
- Defined in src/client.ts:85

deleteBlob

deleteBlob(hash, opts?): Promise<boolean>
Parameters
- hash: string
- Optional opts: Omit<DeleteOptions<URL>, "auth" | "onAuth" | "onPayment"> & {
  auth?: boolean | SignedEvent;
  payment?: boolean;
  }
Returns Promise<boolean>
- Defined in src/client.ts:201

downloadBlob

downloadBlob(hash, opts?): Promise<Blob>
Parameters
- hash: string
- Optional opts: Omit<DownloadOptions<URL>, "auth" | "onAuth" | "onPayment"> & {
  auth?: boolean | SignedEvent;
  payment?: boolean;
  }
Returns Promise<Blob>
- Defined in src/client.ts:61

hasBlob

hasBlob(hash): Promise<boolean>
Parameters
- hash: string
Returns Promise<boolean>
- Defined in src/client.ts:166

listBlobs

listBlobs(pubkey, opts?): Promise<BlobDescriptor[]>
Parameters
- pubkey: string
- Optional opts: Omit<ListOptions<URL>, "auth" | "onAuth" | "onPayment"> & {
  auth?: boolean | SignedEvent;
  payment?: boolean;
  }
Returns Promise<BlobDescriptor[]>
- Defined in src/client.ts:175

mirrorBlob

mirrorBlob(blob, opts?): Promise<BlobDescriptor>
Parameters
- blob: BlobDescriptor
- Optional opts: Omit<MirrorOptions<URL>, "auth" | "onAuth" | "onPayment"> & {
  auth?: boolean | SignedEvent;
  payment?: boolean;
  }
Returns Promise<BlobDescriptor>
- Defined in src/client.ts:115

uploadBlob

uploadBlob<B>(blob, opts?): Promise<BlobDescriptor>
Type Parameters
- B extends UploadType
Parameters
- blob: B
- Optional opts: Omit<UploadOptions<URL, B>, "auth" | "onAuth" | "onPayment"> & {
  auth?: boolean | SignedEvent;
  payment?: boolean;
  }
Returns Promise<BlobDescriptor>
- Defined in src/client.ts:89

uploadMedia

uploadMedia<B>(blob, opts?): Promise<BlobDescriptor>
Type Parameters
- B extends UploadType
Parameters
- blob: B
- Optional opts: Omit<UploadMediaOptions<URL, B>, "auth" | "onAuth" | "onPayment"> & {
  auth?: boolean | SignedEvent;
  payment?: boolean;
  }
Returns Promise<BlobDescriptor>
- Defined in src/client.ts:140

`Static` hasBlob

hasBlob(server, hash): Promise<boolean>
Parameters
- server: ServerType
- hash: string
Returns Promise<boolean>
- Defined in src/client.ts:162

Class BlossomClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BlossomClient

Properties

Optional payment

server

Optional signer

Static createDeleteAuth

Type declaration

Parameters

Returns Promise<SignedEvent>

Static createGetAuth

Type declaration

Parameters

Returns Promise<SignedEvent>

Static createListAuth

Type declaration

Parameters

Returns Promise<SignedEvent>

Static createUploadAuth

Type declaration

Parameters

Returns Promise<SignedEvent>

Static deleteBlob

Type declaration

Type Parameters

Parameters

Returns Promise<boolean>

Static downloadBlob

Type declaration

Type Parameters

Parameters

Returns Promise<Response>

Static encodeAuthorizationHeader

Type declaration

Parameters

Returns string

Static getFileSha256

Type declaration

Parameters

Returns string | Promise<string>

Static listBlobs

Type declaration

Type Parameters

Parameters

Returns Promise<BlobDescriptor[]>

Static mirrorBlob

Type declaration

Type Parameters

Parameters

Returns Promise<BlobDescriptor>

Static uploadBlob

Type declaration

Type Parameters

Parameters

Returns Promise<BlobDescriptor>

Static uploadMedia

Type declaration

Type Parameters

Parameters

Returns Promise<BlobDescriptor>

Methods

createDeleteAuth

Parameters

Returns Promise<SignedEvent>

createDownloadAuth

Parameters

Returns Promise<SignedEvent>

createListAuth

Parameters

Returns Promise<SignedEvent>

createMediaAuth

Parameters

Returns Promise<SignedEvent>

`Optional` payment

`Optional` signer

`Static` createDeleteAuth

`Static` createGetAuth

`Static` createListAuth

`Static` createUploadAuth

`Static` deleteBlob

`Static` downloadBlob

`Static` encodeAuthorizationHeader

`Static` getFileSha256

`Static` listBlobs

`Static` mirrorBlob

`Static` uploadBlob

`Static` uploadMedia

`Static` hasBlob