useInputBuffer.ts
hooks/useInputBuffer.ts
No strong subsystem tag
133
Lines
3386
Bytes
4
Exports
2
Imports
10
Keywords
What this is
This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.
Beginner explanation
This file is one piece of the larger system. Its name, directory, imports, and exports show where it fits. Start by reading the exports and related files first.
How it is used
Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.
Expert explanation
Architecturally, this file intersects with general runtime concerns. It contains 133 lines, 2 detected imports, and 4 detected exports.
Important relationships
Detected exports
BufferEntryUseInputBufferPropsUseInputBufferResultuseInputBuffer
Keywords
currentbufferpendingpushcurrentindextextmaxbuffersizeentrylengthcursoroffsetpastedcontents
Detected imports
react../utils/config.js
Source notes
This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.
Full source
import { useCallback, useRef, useState } from 'react'
import type { PastedContent } from '../utils/config.js'
export type BufferEntry = {
text: string
cursorOffset: number
pastedContents: Record<number, PastedContent>
timestamp: number
}
export type UseInputBufferProps = {
maxBufferSize: number
debounceMs: number
}
export type UseInputBufferResult = {
pushToBuffer: (
text: string,
cursorOffset: number,
pastedContents?: Record<number, PastedContent>,
) => void
undo: () => BufferEntry | undefined
canUndo: boolean
clearBuffer: () => void
}
export function useInputBuffer({
maxBufferSize,
debounceMs,
}: UseInputBufferProps): UseInputBufferResult {
const [buffer, setBuffer] = useState<BufferEntry[]>([])
const [currentIndex, setCurrentIndex] = useState(-1)
const lastPushTime = useRef<number>(0)
const pendingPush = useRef<ReturnType<typeof setTimeout> | null>(null)
const pushToBuffer = useCallback(
(
text: string,
cursorOffset: number,
pastedContents: Record<number, PastedContent> = {},
) => {
const now = Date.now()
// Clear any pending push
if (pendingPush.current) {
clearTimeout(pendingPush.current)
pendingPush.current = null
}
// Debounce rapid changes
if (now - lastPushTime.current < debounceMs) {
pendingPush.current = setTimeout(
pushToBuffer,
debounceMs,
text,
cursorOffset,
pastedContents,
)
return
}
lastPushTime.current = now
setBuffer(prevBuffer => {
// If we're not at the end of the buffer, truncate everything after current position
const newBuffer =
currentIndex >= 0 ? prevBuffer.slice(0, currentIndex + 1) : prevBuffer
// Don't add if it's the same as the last entry
const lastEntry = newBuffer[newBuffer.length - 1]
if (lastEntry && lastEntry.text === text) {
return newBuffer
}
// Add new entry
const updatedBuffer = [
...newBuffer,
{ text, cursorOffset, pastedContents, timestamp: now },
]
// Limit buffer size
if (updatedBuffer.length > maxBufferSize) {
return updatedBuffer.slice(-maxBufferSize)
}
return updatedBuffer
})
// Update current index to point to the new entry
setCurrentIndex(prev => {
const newIndex = prev >= 0 ? prev + 1 : buffer.length
return Math.min(newIndex, maxBufferSize - 1)
})
},
[debounceMs, maxBufferSize, currentIndex, buffer.length],
)
const undo = useCallback((): BufferEntry | undefined => {
if (currentIndex < 0 || buffer.length === 0) {
return undefined
}
const targetIndex = Math.max(0, currentIndex - 1)
const entry = buffer[targetIndex]
if (entry) {
setCurrentIndex(targetIndex)
return entry
}
return undefined
}, [buffer, currentIndex])
const clearBuffer = useCallback(() => {
setBuffer([])
setCurrentIndex(-1)
lastPushTime.current = 0
if (pendingPush.current) {
clearTimeout(pendingPush.current)
pendingPush.current = null
}
}, [lastPushTime, pendingPush])
const canUndo = currentIndex > 0 && buffer.length > 1
return {
pushToBuffer,
undo,
canUndo,
clearBuffer,
}
}