Class AttachmentDefaultService

Service class for Attachment

Implements

AttachmentService

Index

Constructors

constructor

new AttachmentDefaultService(db, bucket, collectionName?): AttachmentDefaultService
Parameters
- db: Db
- bucket: Bucket
- Optional collectionName: string
Returns AttachmentDefaultService
- Defined in src/module/attachment/attachment.service.ts:107

Properties

`Private` attachmentRepository

attachmentRepository: MongoRepository<AttachmentEntity>

`Private` bucket

bucket: Bucket

`Private` db

db: Db

Methods

createAttachment

createAttachment(attachment): Promise<{
id: string;
}>
Create attachment
Parameters
- attachment: CreateAttachmentDto
Returns Promise<{
id: string;
}>
id of created attachment
Implementation of AttachmentService.createAttachment
- Defined in src/module/attachment/attachment.service.ts:125

deleteAttachment

deleteAttachment(attachmentId): Promise<boolean>
Delete attachment by id
Parameters
- attachmentId: string
Returns Promise<boolean>
true if deleted
Implementation of AttachmentService.deleteAttachment
- Defined in src/module/attachment/attachment.service.ts:136

generateUploadSignedUrl

generateUploadSignedUrl(filename, contentType, contentLength): Promise<string>
generate upload signed url
Parameters
- filename: string
  : filename
- contentType: string
  : content type
- contentLength: number
  : content length
Returns Promise<string>
: signed url

Memberof
AttachmentService

Throws
: if error
Implementation of AttachmentService.generateUploadSignedUrl
- Defined in src/module/attachment/attachment.service.ts:217

getBucket

getBucket(): Bucket
get bucket

Returns Bucket
: bucket
Implementation of AttachmentService.getBucket
- Defined in src/module/attachment/attachment.service.ts:114

getDb

getDb(): Db
get db

Returns Db
: db
Implementation of AttachmentService.getDb
- Defined in src/module/attachment/attachment.service.ts:117

getOneAttachment

getOneAttachment(attachmentId, ownerType?, ownerId?): Promise<null | AttachmentEntity>
Get attachment by id, optionally can limit the result by ownerType and ownerId
Parameters
- attachmentId: string
- Optional ownerType: string
- Optional ownerId: string
Returns Promise<null | AttachmentEntity>
Implementation of AttachmentService.getOneAttachment
- Defined in src/module/attachment/attachment.service.ts:147

getPaginatedAttachments

getPaginatedAttachments<T>(options): Promise<PaginatedFindResult<T>>
Get batch of attachments by pagination
Type Parameters
- T extends {
  id: string;
  } = AttachmentEntity
Parameters
- options: FindWithPaginationOptions<T>
Returns Promise<PaginatedFindResult<T>>
Implementation of AttachmentService.getPaginatedAttachments
- Defined in src/module/attachment/attachment.service.ts:167

normalizeAttachment

normalizeAttachment(attachment, normalizer?): Promise<AttachmentResponse>
Normalize attachment to response shape
Parameters
- attachment: Attachment
- normalizer: ((object) => AttachmentResponse) = normalizeAttachmentResponse
  - - (object): AttachmentResponse
    - Parameters
      object: unknown
      Returns AttachmentResponse
Returns Promise<AttachmentResponse>
Implementation of AttachmentService.normalizeAttachment
- Defined in src/module/attachment/attachment.service.ts:191

normalizeAttachments

normalizeAttachments(attachments): Promise<AttachmentResponse[]>
Normalize batch of attachments
Parameters
- attachments: Attachment[]
Returns Promise<AttachmentResponse[]>
Implementation of AttachmentService.normalizeAttachments
- Defined in src/module/attachment/attachment.service.ts:209

updateAttachment

updateAttachment(attachmentId, attachmentPartial): Promise<{
id: string;
}>
Update attachment by id
Parameters
- attachmentId: string
- attachmentPartial: Partial<Attachment>
Returns Promise<{
id: string;
}>
Implementation of AttachmentService.updateAttachment
- Defined in src/module/attachment/attachment.service.ts:179

Class AttachmentDefaultService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: Db

bucket: Bucket

Optional collectionName: string

Returns AttachmentDefaultService

Properties

Private attachmentRepository

Private bucket

Private db

Methods

createAttachment

Parameters

attachment: CreateAttachmentDto

Returns Promise<{ id: string; }>

deleteAttachment

Parameters

attachmentId: string

Returns Promise<boolean>

generateUploadSignedUrl

Parameters

filename: string

contentType: string

contentLength: number

Returns Promise<string>

Memberof

Throws

getBucket

Returns Bucket

getDb

Returns Db

getOneAttachment

Parameters

attachmentId: string

Optional ownerType: string

Optional ownerId: string

Returns Promise<null | AttachmentEntity>

getPaginatedAttachments

Type Parameters

T extends { id: string; } = AttachmentEntity

Parameters

options: FindWithPaginationOptions<T>

Returns Promise<PaginatedFindResult<T>>

normalizeAttachment

Parameters

attachment: Attachment

normalizer: ((object) => AttachmentResponse) = normalizeAttachmentResponse

Parameters

object: unknown

Returns AttachmentResponse

Returns Promise<AttachmentResponse>

normalizeAttachments

Parameters

attachments: Attachment[]

Returns Promise<AttachmentResponse[]>

updateAttachment

Parameters

attachmentId: string

attachmentPartial: Partial<Attachment>

Returns Promise<{ id: string; }>

Settings

Member Visibility

Theme

On This Page

`Optional` collectionName: string

`Private` attachmentRepository

`Private` bucket

`Private` db

Returns Promise<{
id: string;
}>

`Optional` ownerType: string

`Optional` ownerId: string

T extends {
id: string;
} = AttachmentEntity

Returns Promise<{
id: string;
}>