Class StreamsDAO

Hierarchy (View Summary)

BaseDAO
- StreamsDAO

Implements

IStreamsDAO

Constructors

constructor

new StreamsDAO(dbClient: IDbClient): StreamsDAO
Parameters
- dbClient: IDbClient
Returns StreamsDAO
Overrides BaseDAO.constructor
- Defined in src/dao/db/StreamsDAO.ts:7

Properties

`Protected` `Readonly`db

db: IDbClient

Methods

addPathToStream

addPathToStream(streamId: number, path: string): Promise<Stream | null>
Adds or updates the path for a stream (add_path_to_stream).
Parameters
- streamId: number
  The ID of the stream to update.
- path: string
  The new path to associate with the stream.
Returns Promise<Stream | null>
A promise that resolves to the updated stream record or null if not found.
Implementation of IStreamsDAO.addPathToStream
- Defined in src/dao/db/StreamsDAO.ts:110

checkIfUserIsStreamer

checkIfUserIsStreamer(userId: number): Promise<boolean | null>
Checks if the user has a stream token set (Check_if_user_is_streamer).
Parameters
- userId: number
  The ID of the user to check.
Returns Promise<boolean | null>
A promise that resolves to a boolean indicating whether the user is a streamer.
Implementation of IStreamsDAO.checkIfUserIsStreamer
- Defined in src/dao/db/StreamsDAO.ts:10

checkIfUserIsStreaming

checkIfUserIsStreaming(streamerId: number): Promise<boolean>
Checks if the user is currently streaming (check_if_user_is_streaming).
Parameters
- streamerId: number
  The ID of the streamer to check.
Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the user is currently streaming.
Implementation of IStreamsDAO.checkIfUserIsStreaming
- Defined in src/dao/db/StreamsDAO.ts:52

checkIfUserIsStreamingAndPublic

checkIfUserIsStreamingAndPublic(streamerId: number): Promise<boolean>
Checks if the user is streaming and the stream is public (check_if_user_is_streaming_and_public).
Parameters
- streamerId: number
  The ID of the streamer to check.
Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the user is streaming and the stream is public.
Implementation of IStreamsDAO.checkIfUserIsStreamingAndPublic
- Defined in src/dao/db/StreamsDAO.ts:63

createStream

createStream(
    streamerId: number,
    title?: string | null,
    description?: string | null,
): Promise<Stream | null>
Creates a new stream (create_stream) and returns the created record.
Parameters
- streamerId: number
  The ID of the streamer who will create the stream.
- Optionaltitle: string | null
  The title of the stream (optional).
- Optionaldescription: string | null
  The description of the stream (optional).
Returns Promise<Stream | null>
A promise that resolves to the created stream record.
Implementation of IStreamsDAO.createStream
- Defined in src/dao/db/StreamsDAO.ts:14

endAllStreams

endAllStreams(): Promise<Stream[]>
Ends all active streams (end_all_streams) and returns the updated records.

Returns Promise<Stream[]>
A promise that resolves to an array of the updated streams.
Implementation of IStreamsDAO.endAllStreams
- Defined in src/dao/db/StreamsDAO.ts:38

endAllStreamsForUser

endAllStreamsForUser(userId: number): Promise<Stream[]>
Ends all active streams for a user (end_all_streams_for_user) and returns the updated records.
Parameters
- userId: number
  The ID of the user whose streams should be ended.
Returns Promise<Stream[]>
A promise that resolves to an array of the updated streams.
Implementation of IStreamsDAO.endAllStreamsForUser
- Defined in src/dao/db/StreamsDAO.ts:31

endStream

endStream(streamId: number): Promise<Stream | null>
Ends a stream by its ID (end_stream) and returns the updated record or null.
Parameters
- streamId: number
  The ID of the stream to end.
Returns Promise<Stream | null>
A promise that resolves to the updated stream record or null if not found.
Implementation of IStreamsDAO.endStream
- Defined in src/dao/db/StreamsDAO.ts:25

`Protected`executeQuery

executeQuery<T>(query: string, params?: any[]): Promise<T | null>
Type Parameters
- T
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T | null>
Inherited from BaseDAO.executeQuery
- Defined in src/dao/db/BaseDao.ts:83

`Protected`executeQueryMultiple

executeQueryMultiple<T>(query: string, params?: any[]): Promise<T[]>
Type Parameters
- T
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T[]>
Inherited from BaseDAO.executeQueryMultiple
- Defined in src/dao/db/BaseDao.ts:97

getActiveStreams

getActiveStreams(): Promise<Stream[]>
Returns a list of active and public streams (get_active_streams).

Returns Promise<Stream[]>
A promise that resolves to an array of active and public streams.
Implementation of IStreamsDAO.getActiveStreams
- Defined in src/dao/db/StreamsDAO.ts:45

getStreamById

getStreamById(streamId: number): Promise<Stream | null>
Retrieves a stream by its ID (get_stream_by_id).
Parameters
- streamId: number
  The ID of the stream to retrieve.
Returns Promise<Stream | null>
A promise that resolves to the stream record or null if not found.
Implementation of IStreamsDAO.getStreamById
- Defined in src/dao/db/StreamsDAO.ts:77

getStreamsByUserId

getStreamsByUserId(userId: number): Promise<Stream[]>
Retrieves all streams of a user (get_streams_by_user_id).
Parameters
- userId: number
  The ID of the user whose streams are to be retrieved.
Returns Promise<Stream[]>
A promise that resolves to an array of streams associated with the user.
Implementation of IStreamsDAO.getStreamsByUserId
- Defined in src/dao/db/StreamsDAO.ts:84

`Protected`mapCacheError

mapCacheError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapCacheError
- Defined in src/dao/db/BaseDao.ts:47

`Protected`mapError

mapError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapError
- Defined in src/dao/db/BaseDao.ts:60

`Protected`mapPostgresError

mapPostgresError(error: any): DaoError
Parameters
- error: any
Returns DaoError
Inherited from BaseDAO.mapPostgresError
- Defined in src/dao/db/BaseDao.ts:16

`Protected`scalar

scalar<T = any>(query: string, params?: any[]): Promise<T>
Type Parameters
- T = any
Parameters
- query: string
- Optionalparams: any[]
Returns Promise<T>
Inherited from BaseDAO.scalar
- Defined in src/dao/db/BaseDao.ts:109

setStreamLiveStatus

setStreamLiveStatus(streamId: number, isLive: boolean): Promise<Stream | null>
Sets the live status for a stream (set_stream_live_status).
Parameters
- streamId: number
  The ID of the stream to update.
- isLive: boolean
  The new live status of the stream (true for live, false for not live).
Returns Promise<Stream | null>
A promise that resolves to the updated stream record or null if not found.
Implementation of IStreamsDAO.setStreamLiveStatus
- Defined in src/dao/db/StreamsDAO.ts:101

setStreamLockStatus

setStreamLockStatus(streamId: number, isLocked: boolean): Promise<Stream | null>
Sets the lock status for a stream (set_stream_lock_status).
Parameters
- streamId: number
  The ID of the stream to update.
- isLocked: boolean
  The new lock status of the stream (true to lock, false to unlock).
Returns Promise<Stream | null>
A promise that resolves to the updated stream record or null if not found.
Implementation of IStreamsDAO.setStreamLockStatus
- Defined in src/dao/db/StreamsDAO.ts:119

updateStreamDetails

updateStreamDetails(
    streamId: number,
    title?: string | null,
    description?: string | null,
    thumbnail?: string | null,
): Promise<Stream | null>
Updates the details of a stream (update_stream_details).
Parameters
- streamId: number
  The ID of the stream to update.
- Optionaltitle: string | null
  The new title of the stream (optional).
- Optionaldescription: string | null
  The new description of the stream (optional).
- Optionalthumbnail: string | null
  The new thumbnail URL for the stream (optional).
Returns Promise<Stream | null>
A promise that resolves to the updated stream record or null if not found.
Implementation of IStreamsDAO.updateStreamDetails
- Defined in src/dao/db/StreamsDAO.ts:90

Class StreamsDAO

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StreamsDAO

Properties

Protected Readonlydb

Methods

addPathToStream

Parameters

Returns Promise<Stream | null>

checkIfUserIsStreamer

Parameters

Returns Promise<boolean | null>

checkIfUserIsStreaming

Parameters

Returns Promise<boolean>

checkIfUserIsStreamingAndPublic

Parameters

Returns Promise<boolean>

createStream

Parameters

Returns Promise<Stream | null>

endAllStreams

Returns Promise<Stream[]>

endAllStreamsForUser

Parameters

Returns Promise<Stream[]>

endStream

Parameters

Returns Promise<Stream | null>

ProtectedexecuteQuery

Type Parameters

Parameters

Returns Promise<T | null>

ProtectedexecuteQueryMultiple

Type Parameters

Parameters

Returns Promise<T[]>

getActiveStreams

Returns Promise<Stream[]>

getStreamById

Parameters

Returns Promise<Stream | null>

getStreamsByUserId

Parameters

Returns Promise<Stream[]>

ProtectedmapCacheError

Parameters

Returns DaoError

ProtectedmapError

Parameters

Returns DaoError

ProtectedmapPostgresError

Parameters

Returns DaoError

Protectedscalar

Type Parameters

Parameters

Returns Promise<T>

setStreamLiveStatus

Parameters

Returns Promise<Stream | null>

setStreamLockStatus

Parameters

Returns Promise<Stream | null>

updateStreamDetails

Parameters

Returns Promise<Stream | null>

Settings

On This Page

`Protected` `Readonly`db

`Protected`executeQuery

`Protected`executeQueryMultiple

`Protected`mapCacheError

`Protected`mapError

`Protected`mapPostgresError

`Protected`scalar