Class ResourceDescriptor

constructor

• new ResourceDescriptor(
      resource: WebHareBlob | null,
      metadata: ResourceMetadataInit,
  ): ResourceDescriptor

  Parameters

  • resource: WebHareBlob | null
  • metadata: ResourceMetadataInit

  Returns ResourceDescriptor

[Marshaller]

dbLoc

• get dbLoc(): WebHareDBLocation | undefined

  Database location support cached URL generation

  Returns WebHareDBLocation | undefined

dominantColor

• get dominantColor(): string | null

  Returns string | null

• set dominantColor(color: string | null): void

  Parameters

  • color: string | null

  Returns void

extension

• get extension(): string | null

  Returns string | null

file

• get file(): WebHareBlob

  Returns WebHareBlob

fileName

• get fileName(): string | null

  Returns string | null

hash

• get hash(): string | null

  Returns string | null

height

• get height(): number | null

  Returns number | null

mediaType

• get mediaType(): string

  Returns string

refPoint

• get refPoint(): { x: number; y: number } | null

  Returns { x: number; y: number } | null

• set refPoint(refPoint: { x: number; y: number } | null): void

  Parameters

  • refPoint: { x: number; y: number } | null

  Returns void

resource

• get resource(): WebHareBlob

  Returns WebHareBlob

  Deprecated

  Use .file instead

sourceFile

• get sourceFile(): number | null

  Original in image library

  Returns number | null

width

• get width(): number | null

  Returns number | null

clone

• clone(options?: ResourceScanOptions): Promise<ResourceDescriptor>

  Parameters

  • Optionaloptions: ResourceScanOptions

  Returns Promise<ResourceDescriptor>

export

• export(options?: ExportOptions): Promise<ExportedResource>

  Parameters

  • Optionaloptions: ExportOptions

  Returns Promise<ExportedResource>

getMetadata

• getMetadata(): ResourceMetadata

  Returns ResourceMetadata

toLink

• toLink(method?: LinkMethod): string

  Parameters

  • Optionalmethod: LinkMethod

  Returns string

toResized

• toResized(method: ResizeMethod): ResizedImage

  Parameters

  • method: ResizeMethod

  Returns ResizedImage

Staticfrom

• from(
      str: string | Buffer<ArrayBuffer> | WebHareBlob,
      options?: ResourceScanOptions,
  ): Promise<ResourceDescriptor>

  Parameters

  • str: string | Buffer<ArrayBuffer> | WebHareBlob
  • Optionaloptions: ResourceScanOptions

  Returns Promise<ResourceDescriptor>

StaticfromBlob

• fromBlob(
      str: Blob | File,
      options?: ResourceScanOptions,
  ): Promise<ResourceDescriptor>

  Copies the blob to a new WebHareBlob

  Parameters

  • str: Blob | File
  • Optionaloptions: ResourceScanOptions

  Returns Promise<ResourceDescriptor>

StaticfromDisk

• fromDisk(
      path: string,
      options?: ResourceScanOptions,
  ): Promise<ResourceDescriptor>

  Parameters

  • path: string
  • Optionaloptions: ResourceScanOptions

  Returns Promise<ResourceDescriptor>

StaticfromResource

• fromResource(
      resource: string,
      options?: ResourceScanOptions,
  ): Promise<ResourceDescriptor>

  Parameters

  • resource: string
  • Optionaloptions: ResourceScanOptions

  Returns Promise<ResourceDescriptor>

Staticimport

• import(
      resource: ResourceSource,
      options?: ImportOptions,
  ): Promise<ResourceDescriptor>

  Parameters

  • resource: ResourceSource
  • Optionaloptions: ImportOptions

  Returns Promise<ResourceDescriptor>