Recorder Options

caution

TimeCat is going rapid iteration, The API may not stable, If you have any questions, please create a issues or contact the author

Start Record#

const recorder = new Recorder(RecordOptions)

Record Options#

interface RecordOptions {
write?: boolean // write data to indexedDB, default is true
keep?: boolean // keep data in Storage otherwise auto-clear, default is true
audio?: boolean // if your want record audio, default is false
font?: boolean // record font, default is false
plugins?: RecorderPlugin[] // extend plugins here
visibleChange?: boolean // stop or resume recorder when visibleChange, default is false
visibleChangeKeepTime?: number // default is 5000(ms)
rewriteResource?: (RewriteItem | PreFetchItem)[],
disableWatchers?: WatcherType[],
keepAlive?: number // Recorder will be destroyed and activated according to the user's interaction, default to 0(ms)
}
type WatcherType = "WindowWatcher" | "CanvasSnapshotWatcher" | "Canvas2DMutationWatcher" | "CanvasWebGLWatcher" | "FontWatcher" | "TerminateWatcher" | "DOMWatcher" | "FormElementWatcher" | "MouseWatcher" | "ScrollWatcher" | "LocationWatcher"
// make 'http://a.com/path' => 'http://b.com/path' for keep resource
type RewriteItem = {
matches: string[] // example: ['css']
rewrite: {
replaceOrigin: string // example: 'https://xxx.com'
folderPath?: string // /path/xxx
fn?: (pre: string, next: string) => string | void
}
}
type PreFetchItem = {
matches: string[] // example: ['css']
type: 'preFetch' // use preFetch mode, resolve the problem like .tff or .woff cross origin
rewrite: {
replaceOrigin?: string // example: 'https://xxx.com'
folderPath?: string // /path/xxx
crossUrl?: string // is a cross origin server url, default is use https://allorigins.win/
matches?: (string | RegExp)[] // is subMatches, example: ['woff', 'ttf']
fn?: (pre: string, next: string) => string | void
}
}

Recorder Plugin#

see Recorder Plugin

Usage Example#

const recorder = new Recorder()
// receive data on callback
recorder.onData((data: RecordData, next: () => Promise<void>) => {
// get or modify record data
// here just like koa compose middleware
await next() // async call
// get record data after other methods or plugins
// see: Recorder Plugin
})
// stop record and clean all watchers
recorder.destroy()
// clear all records in db
recorder.clearDB()
Last updated by oct16