Skip to content

feat(realtime): enhance RealtimeChannel type #1747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+71 −0
Open

feat(realtime): enhance RealtimeChannel type #1747

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions packages/core/realtime-js/src/RealtimeChannel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,41 @@ export type RealtimeChannelOptions = {
}
}

type RealtimeChangesPayloadBase = {
schema: string
table: string
}

type RealtimeBroadcastChangesPayloadBase = RealtimeChangesPayloadBase & {
id: string
}

export type RealtimeBroadcastInsertPayload<T extends { [key: string]: any }> =
RealtimeBroadcastChangesPayloadBase & {
operation: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT}`
record: T
old_record: null
}

export type RealtimeBroadcastUpdatePayload<T extends { [key: string]: any }> =
RealtimeBroadcastChangesPayloadBase & {
operation: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE}`
record: T
old_record: T
}

export type RealtimeBroadcastDeletePayload<T extends { [key: string]: any }> =
RealtimeBroadcastChangesPayloadBase & {
operation: `${REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE}`
record: null
old_record: T
}

export type RealtimeBroadcastPayload<T extends { [key: string]: any }> =
| RealtimeBroadcastInsertPayload<T>
| RealtimeBroadcastUpdatePayload<T>
| RealtimeBroadcastDeletePayload<T>

type RealtimePostgresChangesPayloadBase = {
schema: string
table: string
Expand Down Expand Up @@ -416,6 +451,42 @@ export default class RealtimeChannel {
payload: T
}) => void
): RealtimeChannel
on<T extends Record<string, unknown>>(
type: `${REALTIME_LISTEN_TYPES.BROADCAST}`,
filter: { event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL },
callback: (payload: {
type: `${REALTIME_LISTEN_TYPES.BROADCAST}`
event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.ALL
payload: RealtimeBroadcastPayload<T>
}) => void
): RealtimeChannel
on<T extends { [key: string]: any }>(
type: `${REALTIME_LISTEN_TYPES.BROADCAST}`,
filter: { event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT },
callback: (payload: {
type: `${REALTIME_LISTEN_TYPES.BROADCAST}`
event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.INSERT
payload: RealtimeBroadcastInsertPayload<T>
}) => void
): RealtimeChannel
on<T extends { [key: string]: any }>(
type: `${REALTIME_LISTEN_TYPES.BROADCAST}`,
filter: { event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE },
callback: (payload: {
type: `${REALTIME_LISTEN_TYPES.BROADCAST}`
event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.UPDATE
payload: RealtimeBroadcastUpdatePayload<T>
}) => void
): RealtimeChannel
on<T extends { [key: string]: any }>(
type: `${REALTIME_LISTEN_TYPES.BROADCAST}`,
filter: { event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE },
callback: (payload: {
type: `${REALTIME_LISTEN_TYPES.BROADCAST}`
event: REALTIME_POSTGRES_CHANGES_LISTEN_EVENT.DELETE
payload: RealtimeBroadcastDeletePayload<T>
}) => void
): RealtimeChannel
on<T extends { [key: string]: any }>(
type: `${REALTIME_LISTEN_TYPES.SYSTEM}`,
filter: {},
Expand Down