Class BaseImagesService<I, IR>

Base images service

Type Parameters

I extends BaseImage = BaseImage
IR extends BaseImageRendition = BaseImageRendition

Index

Constructors

constructor

new BaseImagesService(): BaseImagesService<I, IR>
Type Parameters
- I extends BaseImage = BaseImage
- IR extends BaseImageRendition = BaseImageRendition
Returns BaseImagesService<I, IR>

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected` `Readonly`idService

idService: IdService

`Protected` `Readonly`imageRenditionsService

imageRenditionsService: BaseImageRenditionsService<IR>

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

Accessors

repository

get repository(): Repository
Returns Repository
- Defined in libs/core/src/modules/images/images.service.ts:44

Methods

create

create(opts: CreateImageOptions, ctx: BaseServiceMethodContext): Promise

Create image

Parameters

opts: CreateImageOptions
new image options
ctx: BaseServiceMethodContext
service method context

Returns Promise

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
- id: string
 image id
- ctx: BaseServiceMethodContext
 service method context
Returns Promise<void>
Example
```
await this.imagesService.delete('hcimg:xxxxxxxxxxx');
```
- Defined in libs/core/src/modules/images/images.service.ts:282

`Protected`generateEntityId

generateEntityId(): string
Generate image entity id

Returns string
image entity id
- Defined in libs/core/src/modules/images/images.service.ts:141

getOne

getOne(id: string): Promise<MaybeNull>
Get image by id
Parameters
- id: string
 image id
Returns Promise<MaybeNull>
image if exists or null
Example
```
const image = await this.imagesService.getOne('hcimg:xxxxxxxxxxx');
```
- Defined in libs/core/src/modules/images/images.service.ts:61

getOneOrFail

getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise
Get image by id or throw not found exception
Parameters
- id: string
 image id
- ctx: BaseServiceMethodContext
 service method context
Returns Promise
image if exists
Example
```
const image = await this.imagesService.getOneOrFail('hcimg:xxxxxxxxxxx');
```
- Defined in libs/core/src/modules/images/images.service.ts:75

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
- image: I
 image entity
- OptionalrenditionType: ImageRenditionType
 image rendition type
Returns Promise<MaybeNull<string>>
image url if exists or null
- Defined in libs/core/src/modules/images/images.service.ts:102

getUrlById

getUrlById(
id: string,
renditionType?: ImageRenditionType,
): Promise<MaybeNull<string>>
Get image url by id
Parameters
- id: string
 image id
- OptionalrenditionType: ImageRenditionType
 image rendition type
Returns Promise<MaybeNull<string>>
image url if exists or null
- Defined in libs/core/src/modules/images/images.service.ts:127

onModuleInit

onModuleInit(): void
Returns void
- Defined in libs/core/src/modules/images/images.service.ts:48

sync

sync(opts: SyncImageInput, ctx: BaseServiceMethodContext): Promise
Sync image from external source
Parameters
- opts: SyncImageInput
 sync image options
- ctx: BaseServiceMethodContext
 service method context
Returns Promise
synced image
- Defined in libs/core/src/modules/images/images.service.ts:240

update

update(opts: UpdateImageOptions, ctx: BaseServiceMethodContext): Promise
Update image entity
Parameters
- opts: UpdateImageOptions
 update image options
- ctx: BaseServiceMethodContext
 service method context
Returns Promise
updated image
- Defined in libs/core/src/modules/images/images.service.ts:205

Class BaseImagesService<I, IR>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns BaseImagesService<I, IR>

Properties

Protected ReadonlydataSource

Protected ReadonlyidService

Protected ReadonlyimageRenditionsService

Protectedlogger

Protected ReadonlyloggerFactory

Accessors

repository

Returns Repository<I>

Methods

create

Parameters

Returns Promise<I>

Example

delete

Parameters

Returns Promise<void>

Example

ProtectedgenerateEntityId

Returns string

getOne

Parameters

Returns Promise<MaybeNull<I>>

Example

getOneOrFail

Parameters

Returns Promise<I>

Example

getUrl

Parameters

Returns Promise<MaybeNull<string>>

getUrlById

Parameters

Returns Promise<MaybeNull<string>>

onModuleInit

Returns void

sync

Parameters

Returns Promise<I>

update

Parameters

Returns Promise<I>

Settings

On This Page

`Protected` `Readonly`dataSource

`Protected` `Readonly`idService

`Protected` `Readonly`imageRenditionsService

`Protected`logger

`Protected` `Readonly`loggerFactory

`Protected`generateEntityId