Class BaseStudiosService<S>

A Studios service is a component of your video production application's backend that provides programmatic access to the Studios API. It typically includes methods for creating, retrieving, updating, and deleting studios, as well as managing staff and video production associated with each studio.

Type Parameters

S extends BaseStudio

Index

Constructors

constructor

new BaseStudiosService<S extends BaseStudio>(): BaseStudiosService<S>
Type Parameters
- S extends BaseStudio
Returns BaseStudiosService<S>

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected` `Readonly`idService

idService: IdService

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

Accessors

studioRepository

get studioRepository(): Repository<S>
Returns Repository<S>
- Defined in libs/core/src/modules/studios/studios.service.ts:47

Methods

`Protected`applyFilterToQuery

applyFilterToQuery(query: SelectQueryBuilder<S>, filter: StudiosFilter): void
Apply studios filter to query
Parameters
- query: SelectQueryBuilder<S>
  typeorm query builder
- filter: StudiosFilter
  studios filter
Returns void
- Defined in libs/core/src/modules/studios/studios.service.ts:132

`Protected`applyOrderByToQuery

applyOrderByToQuery(query: SelectQueryBuilder<S>, orderBy: StudiosOrderBy): void
Apply studios order to typeorm query builder
Parameters
- query: SelectQueryBuilder<S>
  typeorm query builder
- orderBy: StudiosOrderBy
  studios order
Returns void
- Defined in libs/core/src/modules/studios/studios.service.ts:166

create

create(opts: CreateStudioOptions, ctx: BaseServiceMethodContext): Promise<S>
Create new studio
Parameters
- opts: CreateStudioOptions
  create studio options
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<S>
created studio
Example
```
const studio = await studiosService.create({
 title: 'Hope Channel Studio',
 organizationId: 'hcorg:xxxxxxxxxxx',
});
```
- Defined in libs/core/src/modules/studios/studios.service.ts:188

delete

delete(id: string, ctx: BaseServiceMethodContext): Promise<void>
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise<void>
- Defined in libs/core/src/modules/studios/studios.service.ts:270

`Protected`generateEntityId

generateEntityId(): string
Returns string
- Defined in libs/core/src/modules/studios/studios.service.ts:171

getMany

getMany(opts: GetManyStudiosOptions): Promise<[S[], ListMeta]>
Get studios list
Parameters
- opts: GetManyStudiosOptions
  find studios options
Returns Promise<[S[], ListMeta]>
studios list and list meta
- Defined in libs/core/src/modules/studios/studios.service.ts:98

getOne

getOne(id: string): Promise<MaybeNull<S>>
Get studio by id
Parameters
- id: string
  studio id
Returns Promise<MaybeNull<S>>
studio or null if not found
- Defined in libs/core/src/modules/studios/studios.service.ts:62

getOneOrFail

getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise<S>
Get studio by id or throw NotFoundException
Parameters
- id: string
  studio id
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<S>
studio or throw NotFoundException if not found
- Defined in libs/core/src/modules/studios/studios.service.ts:75

onModuleInit

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

sync

sync(
__namedParameters: SyncStudioOptions,
ctx: BaseServiceMethodContext,
): Promise<S>
Parameters
- __namedParameters: SyncStudioOptions
- ctx: BaseServiceMethodContext
Returns Promise<S>
- Defined in libs/core/src/modules/studios/studios.service.ts:238

update

update(
__namedParameters: UpdateStudioOptions,
ctx: BaseServiceMethodContext,
): Promise<S>
Parameters
- __namedParameters: UpdateStudioOptions
- ctx: BaseServiceMethodContext
Returns Promise<S>
- Defined in libs/core/src/modules/studios/studios.service.ts:210

Class BaseStudiosService<S>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns BaseStudiosService<S>

Properties

Protected ReadonlydataSource

Protected ReadonlyidService

Protectedlogger

Protected ReadonlyloggerFactory

Accessors

studioRepository

Returns Repository<S>

Methods

ProtectedapplyFilterToQuery

Parameters

Returns void

ProtectedapplyOrderByToQuery

Parameters

Returns void

create

Parameters

Returns Promise<S>

Example

delete

Parameters

Returns Promise<void>

ProtectedgenerateEntityId

Returns string

getMany

Parameters

Returns Promise<[S[], ListMeta]>

getOne

Parameters

Returns Promise<MaybeNull<S>>

getOneOrFail

Parameters

Returns Promise<S>

onModuleInit

Returns void

sync

Parameters

Returns Promise<S>

update

Parameters

Returns Promise<S>

Settings

On This Page

`Protected` `Readonly`dataSource

`Protected` `Readonly`idService

`Protected`logger

`Protected` `Readonly`loggerFactory

`Protected`applyFilterToQuery

`Protected`applyOrderByToQuery

`Protected`generateEntityId