IWithFeaturedImageBehavior

Interface

Composable behavior that adds featured image support to an entity class

Methods

Method Returns Notes
Promise<void>

Clears the featured image for the item

Promise<void>

Set the featured image for the item

clearFeaturedImage

Interface Method

Clears the featured image for the item

  • clearFeaturedImage(filename: string) : Promise<void>

Parameters

Parameter Type Default Notes
filename Required string

Returns

Promise<void>

setFeaturedImage

Interface Method

Set the featured image for the item

  • setFeaturedImage(file: any, clearExisting: boolean) : Promise<void>

Parameters

Parameter Type Default Notes
file Required any
clearExisting Required boolean

Returns

Promise<void>

Interface defined in common/src/core/behaviors/IWithFeaturedImageBehavior.ts:4