Class ResourceDescriptor

constructor

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

  Parameters

  • resource: null | WebHareBlob
  • metadata: ResourceMetaDataInit

  Returns ResourceDescriptor

[Marshaller]

dbLoc

• get dbLoc(): undefined | { cc: number; id: number; source: number }

  Database location support cached URL generation

  Returns undefined | { cc: number; id: number; source: number }

  • undefined
  • { cc: number; id: number; source: number }

    • cc: number

      Creation check. Type-specific identifier to protect against replays if an ID is reused

    • id: number

      ID

    • source: number

      Source. 1 = fsobjects, 2 = fssettings, 3 = wrdsetting, 4 = formresult

dominantColor

• get dominantColor(): null | string

  Returns null | string

extension

• get extension(): null | string

  Returns null | string

fileName

• get fileName(): null | string

  Returns null | string

hash

• get hash(): null | string

  Returns null | string

height

• get height(): null | number

  Returns null | number

mediaType

• get mediaType(): string

  Returns string

mirrored

• get mirrored(): null | boolean

  Returns null | boolean

refPoint

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

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

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

  Parameters

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

  Returns void

resource

• get resource(): WebHareBlob

  Returns WebHareBlob

rotation

• get rotation(): null | Rotation

  Returns null | Rotation

sourceFile

• get sourceFile(): null | number

  Returns null | number

width

• get width(): null | number

  Returns null | number

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): { link: string }

  Parameters

  • method: ResizeMethod

  Returns { link: string }

Staticfrom

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

  Parameters

  • str: string | Buffer<ArrayBufferLike> | 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: ExportedResource): Promise<ResourceDescriptor>

  Parameters

  • resource: ExportedResource

  Returns Promise<ResourceDescriptor>