Skip to content

types: add SnapshotRecorderMode #4442

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

Merged
merged 2 commits into from
Aug 22, 2025
Merged

types: add SnapshotRecorderMode #4442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b92dc00
types: add SnapshotRecorderMode
Uzlopak Aug 21, 2025
6b29d79
fix types
Uzlopak Aug 21, 2025
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
8 changes: 4 additions & 4 deletions test/types/snapshot-agent.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ expectAssignable<Dispatcher>(new SnapshotAgent())
expectType<Promise<void>>(snapshotAgent.loadSnapshots())
expectType<Promise<void>>(snapshotAgent.loadSnapshots('./custom.json'))
expectType<SnapshotRecorder>(snapshotAgent.getRecorder())
expectType<'record' | 'playback' | 'update'>(snapshotAgent.getMode())
expectType<SnapshotRecorder.SnapshotRecorderMode>(snapshotAgent.getMode())
expectType<void>(snapshotAgent.clearSnapshots())

// New snapshot management methods
Expand Down Expand Up @@ -361,9 +361,9 @@ expectAssignable<SnapshotAgent.Options>({
const playbackAgent = new SnapshotAgent({ mode: 'playback', snapshotPath: './test.json' })
const updateAgent = new SnapshotAgent({ mode: 'update', snapshotPath: './test.json' })

expectType<'record' | 'playback' | 'update'>(recordAgent.getMode())
expectType<'record' | 'playback' | 'update'>(playbackAgent.getMode())
expectType<'record' | 'playback' | 'update'>(updateAgent.getMode())
expectType<SnapshotRecorder.SnapshotRecorderMode>(recordAgent.getMode())
expectType<SnapshotRecorder.SnapshotRecorderMode>(playbackAgent.getMode())
expectType<SnapshotRecorder.SnapshotRecorderMode>(updateAgent.getMode())
}

{
Expand Down
8 changes: 5 additions & 3 deletions types/snapshot-agent.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ declare class SnapshotRecorder {
}

declare namespace SnapshotRecorder {
type SnapshotRecorderMode = 'record' | 'playback' | 'update'

export interface Options {
snapshotPath?: string
mode?: 'record' | 'playback' | 'update'
mode?: SnapshotRecorderMode
maxSnapshots?: number
autoFlush?: boolean
flushInterval?: number
Expand Down Expand Up @@ -77,7 +79,7 @@ declare class SnapshotAgent extends MockAgent {
saveSnapshots (filePath?: string): Promise<void>
loadSnapshots (filePath?: string): Promise<void>
getRecorder (): SnapshotRecorder
getMode (): 'record' | 'playback' | 'update'
getMode (): SnapshotRecorder.SnapshotRecorderMode
clearSnapshots (): void
resetCallCounts (): void
deleteSnapshot (requestOpts: any): boolean
Expand All @@ -87,7 +89,7 @@ declare class SnapshotAgent extends MockAgent {

declare namespace SnapshotAgent {
export interface Options extends MockAgent.Options {
mode?: 'record' | 'playback' | 'update'
mode?: SnapshotRecorder.SnapshotRecorderMode
snapshotPath?: string
maxSnapshots?: number
autoFlush?: boolean
Expand Down
Loading