Class BaseImagesService<I, IR>

Base images service

Type Parameters

Constructors

constructor

Properties

dataSource idService imageRenditionsService logger loggerFactory

Accessors

repository

Methods

create delete generateEntityId getOne getOneOrFail getUrl getUrlById onModuleInit sync update

Constructors

constructor

Properties

Protected ReadonlydataSource

dataSource: DataSource

Protected ReadonlyidService

idService: IdService

Protected ReadonlyimageRenditionsService

imageRenditionsService: BaseImageRenditionsService<IR>

Protectedlogger

logger: WinstonLogger

Protected ReadonlyloggerFactory

loggerFactory: WinstonLoggerFactory

Accessors

repository

  • get repository(): Repository<I>

    Returns Repository<I>

Methods

create

  • create(opts: CreateImageOptions, ctx: BaseServiceMethodContext): Promise<I>

    Create image

    Parameters

    Returns Promise<I>

    created image

    Example

    const image = await this.imagesService.create({
     id: 'hcimg:xxxxxxxxxxx',
     renditions: [{
       type: ImageRenditionType.SMALL,
       url: 'https://example.com/image.jpg',
       meta: {
        width: 100,
        height: 100,
        mimeType: 'image/jpeg',
        fileSize: 20344,
       },
     }],
    });

delete

  • delete(id: string, ctx: BaseServiceMethodContext): Promise<void>

    Delete image

    Parameters

    Returns Promise<void>

    Example

    await this.imagesService.delete('hcimg:xxxxxxxxxxx');

ProtectedgenerateEntityId

  • generateEntityId(): string

    Generate image entity id

    Returns string

    image entity id

getOne

  • getOne(id: string): Promise<MaybeNull<I>>

    Get image by id

    Parameters

    • id: string

      image id

    Returns Promise<MaybeNull<I>>

    image if exists or null

    Example

    const image = await this.imagesService.getOne('hcimg:xxxxxxxxxxx');

getOneOrFail

  • getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise<I>

    Get image by id or throw not found exception

    Parameters

    Returns Promise<I>

    image if exists

    Example

    const image = await this.imagesService.getOneOrFail('hcimg:xxxxxxxxxxx');

getUrl

  • getUrl(image: I, renditionType?: ImageRenditionType): Promise<MaybeNull<string>>

    Get image url If rendition type is provided, it will return url for this rendition type If rendition type is not provided, it will return url for first available rendition type: MAIN_2X, MAIN, MAIN_LEGACY, ORIGINAL

    Parameters

    Returns Promise<MaybeNull<string>>

    image url if exists or null

getUrlById

  • getUrlById(
        id: string,
        renditionType?: ImageRenditionType,
    ): Promise<MaybeNull<string>>

    Get image url by id

    Parameters

    Returns Promise<MaybeNull<string>>

    image url if exists or null

onModuleInit

  • onModuleInit(): void

    Returns void

sync

update

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods