SYMBOL INDEX (236 symbols across 105 files)

FILE: apps/www/next.config.js
  method redirects (line 16) | async redirects() {

FILE: apps/www/src/app/(docs)/introduction/page.tsx
  function IntroductionPage (line 7) | async function IntroductionPage() {

FILE: apps/www/src/app/(docs)/layout.tsx
  type DocsLayoutProps (line 11) | type DocsLayoutProps = {
  function DocsLayout (line 15) | async function DocsLayout({ children }: DocsLayoutProps) {

FILE: apps/www/src/app/(docs)/migrate-to-v3/page.tsx
  function MigrateToV3Page (line 5) | async function MigrateToV3Page() {

FILE: apps/www/src/app/(docs)/react-hook/[slug]/page.tsx
  function stringifyDescription (line 15) | function stringifyDescription(description: string) {
  function getPostUrl (line 19) | function getPostUrl(slug: string) {
  function getImageUrl (line 23) | function getImageUrl(name: string) {
  function HookPage (line 66) | async function HookPage({

FILE: apps/www/src/app/(marketing)/layout.tsx
  type MarketingLayoutProps (line 9) | type MarketingLayoutProps = {
  function MarketingLayout (line 13) | async function MarketingLayout({

FILE: apps/www/src/app/(marketing)/page.tsx
  type Feature (line 20) | type Feature = {
  function getGitHubStars (line 65) | async function getGitHubStars(): Promise<string | null> {
  function IndexPage (line 93) | async function IndexPage() {

FILE: apps/www/src/app/layout.tsx
  type RootLayoutProps (line 22) | type RootLayoutProps = {
  function RootLayout (line 75) | function RootLayout({ children }: RootLayoutProps) {

FILE: apps/www/src/components/buy-me-a-coffee.tsx
  function BuyMeACoffee (line 3) | function BuyMeACoffee() {
  function BuyMeACoffeeLogo (line 17) | function BuyMeACoffeeLogo({

FILE: apps/www/src/components/carbon-ads/ads.tsx
  type CarbonAdsProps (line 11) | type CarbonAdsProps = {
  function CarbonAds (line 17) | function CarbonAds({

FILE: apps/www/src/components/command-copy.tsx
  type CommandCopyProps (line 18) | type CommandCopyProps = {
  function CommandCopy (line 23) | function CommandCopy({

FILE: apps/www/src/components/doc-search/command-menu.tsx
  function CommandMenu (line 14) | function CommandMenu() {

FILE: apps/www/src/components/doc-search/footer.tsx
  function Footer (line 1) | function Footer() {
  function EscapeKey (line 42) | function EscapeKey() {
  function ArrowDownKey (line 58) | function ArrowDownKey() {
  function ArrowUpKey (line 73) | function ArrowUpKey() {
  function EnterKey (line 89) | function EnterKey() {
  function Kbd (line 105) | function Kbd({ children }: { children: React.ReactNode }) {
  function AlgoliaLogo (line 113) | function AlgoliaLogo() {

FILE: apps/www/src/components/doc-search/hits.tsx
  function RenderHits (line 8) | function RenderHits() {
  type HitProps (line 32) | type HitProps = {
  function HitComponent (line 37) | function HitComponent({ hit, makeUrl }: HitProps) {

FILE: apps/www/src/components/doc-search/input.tsx
  function SearchInput (line 7) | function SearchInput() {

FILE: apps/www/src/components/doc-search/modal.context.tsx
  type CommandMenuContextType (line 7) | type CommandMenuContextType = {
  function CommandMenuProvider (line 23) | function CommandMenuProvider(props: { children: React.ReactNode }) {
  function useCommandMenuContext (line 48) | function useCommandMenuContext() {

FILE: apps/www/src/components/doc-search/open-button.tsx
  type ButtonProps (line 9) | type ButtonProps = Omit<

FILE: apps/www/src/components/doc-search/types.ts
  type Highlight (line 1) | type Highlight = {
  type Fields (line 7) | type Fields<T> = {
  type Hit (line 13) | type Hit = Fields<string> & {

FILE: apps/www/src/components/doc-search/use-cmd-k.ts
  function useCmdK (line 3) | function useCmdK(callback: () => void) {

FILE: apps/www/src/components/docs/left-sidebar.tsx
  type DocsSidebarNavProps (line 9) | type DocsSidebarNavProps = {
  function LeftSidebar (line 14) | function LeftSidebar(props: DocsSidebarNavProps) {
  type NavItemsProps (line 41) | type NavItemsProps = {
  function NavItems (line 46) | function NavItems({ items, pathname }: NavItemsProps) {

FILE: apps/www/src/components/docs/page-header.tsx
  type DocsPageHeaderProps (line 3) | type DocsPageHeaderProps = {
  function PageHeader (line 8) | function PageHeader({

FILE: apps/www/src/components/docs/pager.tsx
  type DocsPagerProps (line 8) | type DocsPagerProps = {
  function Pager (line 13) | function Pager({ slug, hooks }: DocsPagerProps) {
  function getPaperElements (line 44) | function getPaperElements({ slug, hooks }: DocsPagerProps) {

FILE: apps/www/src/components/docs/right-sidebar.tsx
  type Props (line 5) | type Props = {
  function RightSidebar (line 9) | function RightSidebar({ toc }: Props) {

FILE: apps/www/src/components/docs/table-of-content.tsx
  type Item (line 7) | type Item = {
  type Items (line 13) | type Items = {
  type TableOfContents (line 17) | type TableOfContents = Items
  type TocItem (line 18) | type TocItem = Item
  type TocProps (line 20) | type TocProps = {
  function TableOfContent (line 24) | function TableOfContent({ toc }: TocProps) {
  function useActiveItem (line 51) | function useActiveItem(itemIds: (string | undefined)[]) {
  type TreeProps (line 94) | type TreeProps = {
  function Tree (line 100) | function Tree({ tree, level = 1, activeItem }: TreeProps) {

FILE: apps/www/src/components/main-nav.tsx
  type MainNavProps (line 14) | type MainNavProps = {
  function MainNav (line 19) | function MainNav({ items, children }: MainNavProps) {

FILE: apps/www/src/components/mobile-nav.tsx
  type MobileNavProps (line 11) | type MobileNavProps = {
  function MobileNav (line 16) | function MobileNav({ items, children }: MobileNavProps) {

FILE: apps/www/src/components/ui/button.tsx
  type ButtonProps (line 38) | type ButtonProps = {

FILE: apps/www/src/components/ui/command.tsx
  type CommandDialogProps (line 27) | type CommandDialogProps = DialogProps

FILE: apps/www/src/lib/api.ts
  constant SOURCE_PATH (line 12) | const SOURCE_PATH = path.resolve(process.cwd(), '..', '..', 'generated',...

FILE: apps/www/src/lib/utils.ts
  function cn (line 7) | function cn(...inputs: ClassValue[]) {
  function mapHookToNavLink (line 11) | function mapHookToNavLink(hook: BaseHook): NavItem {

FILE: apps/www/src/types/index.ts
  type SiteConfig (line 3) | type SiteConfig = {
  type BaseHook (line 14) | type BaseHook = {
  type NavItem (line 21) | type NavItem = {
  type MainNavItem (line 27) | type MainNavItem = NavItem
  type SidebarNavItem (line 29) | type SidebarNavItem = {
  type DocsConfig (line 45) | type DocsConfig = {
  type MarketingConfig (line 50) | type MarketingConfig = {

FILE: packages/usehooks-ts/src/useBoolean/useBoolean.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useBoolean/useBoolean.ts
  type UseBooleanReturn (line 6) | type UseBooleanReturn = {
  function useBoolean (line 31) | function useBoolean(defaultValue = false): UseBooleanReturn {

FILE: packages/usehooks-ts/src/useClickAnyWhere/useClickAnyWhere.demo.tsx
  function Component (line 5) | function Component() {

FILE: packages/usehooks-ts/src/useClickAnyWhere/useClickAnyWhere.ts
  function useClickAnyWhere (line 18) | function useClickAnyWhere(handler: (event: MouseEvent) => void) {

FILE: packages/usehooks-ts/src/useCopyToClipboard/useCopyToClipboard.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useCopyToClipboard/useCopyToClipboard.ts
  type CopiedValue (line 6) | type CopiedValue = string | null
  type CopyFn (line 13) | type CopyFn = (text: string) => Promise<boolean>
  function useCopyToClipboard (line 36) | function useCopyToClipboard(): [CopiedValue, CopyFn] {

FILE: packages/usehooks-ts/src/useCountdown/useCountdown.demo.tsx
  function Component (line 7) | function Component() {

FILE: packages/usehooks-ts/src/useCountdown/useCountdown.ts
  type CountdownOptions (line 8) | type CountdownOptions = {
  type CountdownControllers (line 31) | type CountdownControllers = {
  function useCountdown (line 55) | function useCountdown({

FILE: packages/usehooks-ts/src/useCounter/useCounter.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useCounter/useCounter.ts
  type UseCounterReturn (line 6) | type UseCounterReturn = {
  function useCounter (line 30) | function useCounter(initialValue?: number): UseCounterReturn {

FILE: packages/usehooks-ts/src/useDarkMode/useDarkMode.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useDarkMode/useDarkMode.ts
  constant COLOR_SCHEME_QUERY (line 5) | const COLOR_SCHEME_QUERY = '(prefers-color-scheme: dark)'
  constant LOCAL_STORAGE_KEY (line 6) | const LOCAL_STORAGE_KEY = 'usehooks-ts-dark-mode'
  type DarkModeOptions (line 9) | type DarkModeOptions = {
  type DarkModeReturn (line 29) | type DarkModeReturn = {
  function useDarkMode (line 53) | function useDarkMode(options: DarkModeOptions = {}): DarkModeReturn {

FILE: packages/usehooks-ts/src/useDebounceCallback/useDebounceCallback.demo.tsx
  function Component (line 5) | function Component() {

FILE: packages/usehooks-ts/src/useDebounceCallback/useDebounceCallback.ts
  type DebounceOptions (line 8) | type DebounceOptions = {
  type ControlFunctions (line 26) | type ControlFunctions = {
  type DebouncedState (line 45) | type DebouncedState<T extends (...args: any) => ReturnType<T>> = ((
  function useDebounceCallback (line 74) | function useDebounceCallback<T extends (...args: any) => ReturnType<T>>(

FILE: packages/usehooks-ts/src/useDebounceValue/useDebounceValue.demo.tsx
  function Component (line 3) | function Component({ defaultValue = 'John' }) {

FILE: packages/usehooks-ts/src/useDebounceValue/useDebounceValue.ts
  type UseDebounceValueOptions (line 10) | type UseDebounceValueOptions<T> = {
  function useDebounceValue (line 43) | function useDebounceValue<T>(

FILE: packages/usehooks-ts/src/useDocumentTitle/useDocumentTitle.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useDocumentTitle/useDocumentTitle.ts
  type UseDocumentTitleOptions (line 7) | type UseDocumentTitleOptions = {
  function useDocumentTitle (line 23) | function useDocumentTitle(

FILE: packages/usehooks-ts/src/useEventCallback/useEventCallback.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useEventCallback/useEventCallback.ts
  function useEventCallback (line 26) | function useEventCallback<Args extends unknown[], R>(

FILE: packages/usehooks-ts/src/useEventListener/useEventListener.demo.tsx
  function Component (line 5) | function Component() {

FILE: packages/usehooks-ts/src/useEventListener/useEventListener.test.ts
  type WindowEventMap (line 7) | interface WindowEventMap {
  type HTMLElementEventMap (line 11) | interface HTMLElementEventMap {
  type SVGElementEventMap (line 15) | interface SVGElementEventMap {
  type DocumentEventMap (line 19) | interface DocumentEventMap {

FILE: packages/usehooks-ts/src/useEventListener/useEventListener.ts
  function useEventListener (line 76) | function useEventListener<

FILE: packages/usehooks-ts/src/useHover/useHover.demo.tsx
  function Component (line 5) | function Component() {

FILE: packages/usehooks-ts/src/useHover/useHover.ts
  function useHover (line 21) | function useHover<T extends HTMLElement = HTMLElement>(

FILE: packages/usehooks-ts/src/useIntersectionObserver/useIntersectionObserver.demo.tsx
  function Component (line 27) | function Component() {

FILE: packages/usehooks-ts/src/useIntersectionObserver/useIntersectionObserver.ts
  type State (line 4) | type State = {
  type UseIntersectionObserverOptions (line 12) | type UseIntersectionObserverOptions = {
  type IntersectionReturn (line 55) | type IntersectionReturn = [
  function useIntersectionObserver (line 82) | function useIntersectionObserver({

FILE: packages/usehooks-ts/src/useInterval/useInterval.demo.tsx
  function Component (line 7) | function Component() {

FILE: packages/usehooks-ts/src/useInterval/useInterval.test.ts
  function mockSetInterval (line 54) | function mockSetInterval() {
  function mockClearInterval (line 58) | function mockClearInterval() {

FILE: packages/usehooks-ts/src/useInterval/useInterval.ts
  function useInterval (line 19) | function useInterval(callback: () => void, delay: number | null) {

FILE: packages/usehooks-ts/src/useIsClient/useIsClient.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useIsClient/useIsClient.ts
  function useIsClient (line 14) | function useIsClient() {

FILE: packages/usehooks-ts/src/useIsMounted/useIsMounted.demo.tsx
  function Child (line 7) | function Child() {
  function Component (line 21) | function Component() {

FILE: packages/usehooks-ts/src/useIsMounted/useIsMounted.ts
  function useIsMounted (line 14) | function useIsMounted(): () => boolean {

FILE: packages/usehooks-ts/src/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useLocalStorage/useLocalStorage.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useLocalStorage/useLocalStorage.ts
  type WindowEventMap (line 10) | interface WindowEventMap {
  type UseLocalStorageOptions (line 19) | type UseLocalStorageOptions<T> = {
  constant IS_SERVER (line 31) | const IS_SERVER = typeof window === 'undefined'
  function useLocalStorage (line 48) | function useLocalStorage<T>(

FILE: packages/usehooks-ts/src/useMap/useMap.demo.tsx
  function Component (line 5) | function Component() {

FILE: packages/usehooks-ts/src/useMap/useMap.ts
  type MapOrEntries (line 8) | type MapOrEntries<K, V> = Map<K, V> | [K, V][]
  type UseMapActions (line 15) | type UseMapActions<K, V> = {
  type UseMapReturn (line 32) | type UseMapReturn<K, V> = [
  function useMap (line 51) | function useMap<K, V>(

FILE: packages/usehooks-ts/src/useMediaQuery/useMediaQuery.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useMediaQuery/useMediaQuery.ts
  type UseMediaQueryOptions (line 6) | type UseMediaQueryOptions = {
  constant IS_SERVER (line 19) | const IS_SERVER = typeof window === 'undefined'
  function useMediaQuery (line 34) | function useMediaQuery(

FILE: packages/usehooks-ts/src/useOnClickOutside/useOnClickOutside.demo.tsx
  function Component (line 5) | function Component() {

FILE: packages/usehooks-ts/src/useOnClickOutside/useOnClickOutside.ts
  type EventType (line 6) | type EventType =
  function useOnClickOutside (line 32) | function useOnClickOutside<T extends HTMLElement = HTMLElement>(

FILE: packages/usehooks-ts/src/useReadLocalStorage/useReadLocalStorage.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useReadLocalStorage/useReadLocalStorage.ts
  constant IS_SERVER (line 5) | const IS_SERVER = typeof window === 'undefined'
  type Options (line 11) | type Options<T, InitializeWithValue extends boolean | undefined> = {
  function useReadLocalStorage (line 42) | function useReadLocalStorage<T>(

FILE: packages/usehooks-ts/src/useResizeObserver/useResizeObserver.demo.tsx
  type Size (line 6) | type Size = {
  function Component (line 11) | function Component() {
  function WithDebounce (line 25) | function WithDebounce() {

FILE: packages/usehooks-ts/src/useResizeObserver/useResizeObserver.ts
  type Size (line 8) | type Size = {
  type UseResizeObserverOptions (line 16) | type UseResizeObserverOptions<T extends HTMLElement = HTMLElement> = {
  function useResizeObserver (line 54) | function useResizeObserver<T extends HTMLElement = HTMLElement>(
  type BoxSizesKey (line 110) | type BoxSizesKey = keyof Pick<
  function extractSize (line 115) | function extractSize(

FILE: packages/usehooks-ts/src/useScreen/useScreen.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useScreen/useScreen.ts
  type UseScreenOptions (line 11) | type UseScreenOptions<InitializeWithValue extends boolean | undefined> = {
  constant IS_SERVER (line 24) | const IS_SERVER = typeof window === 'undefined'
  function useScreen (line 42) | function useScreen(

FILE: packages/usehooks-ts/src/useScript/useScript.demo.tsx
  function Component (line 9) | function Component() {

FILE: packages/usehooks-ts/src/useScript/useScript.ts
  type UseScriptStatus (line 4) | type UseScriptStatus = 'idle' | 'loading' | 'ready' | 'error'
  type UseScriptOptions (line 7) | type UseScriptOptions = {
  function getScriptNode (line 29) | function getScriptNode(src: string) {
  function useScript (line 53) | function useScript(

FILE: packages/usehooks-ts/src/useScrollLock/useScrollLock.demo.tsx
  function Modal (line 4) | function Modal() {
  function App (line 10) | function App() {

FILE: packages/usehooks-ts/src/useScrollLock/useScrollLock.ts
  type UseScrollLockOptions (line 6) | type UseScrollLockOptions = {
  type UseScrollLockReturn (line 25) | type UseScrollLockReturn = {
  type OriginalStyle (line 34) | type OriginalStyle = {
  constant IS_SERVER (line 39) | const IS_SERVER = typeof window === 'undefined'
  function useScrollLock (line 65) | function useScrollLock(

FILE: packages/usehooks-ts/src/useSessionStorage/useSessionStorage.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useSessionStorage/useSessionStorage.ts
  type WindowEventMap (line 10) | interface WindowEventMap {
  type UseSessionStorageOptions (line 19) | type UseSessionStorageOptions<T> = {
  constant IS_SERVER (line 31) | const IS_SERVER = typeof window === 'undefined'
  function useSessionStorage (line 48) | function useSessionStorage<T>(

FILE: packages/usehooks-ts/src/useStep/useStep.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useStep/useStep.ts
  type UseStepActions (line 6) | type UseStepActions = {
  type SetStepCallbackType (line 21) | type SetStepCallbackType = (step: number | ((step: number) => number)) =...
  function useStep (line 35) | function useStep(maxStep: number): [number, UseStepActions] {

FILE: packages/usehooks-ts/src/useTernaryDarkMode/useTernaryDarkMode.demo.tsx
  type TernaryDarkMode (line 3) | type TernaryDarkMode = ReturnType<typeof useTernaryDarkMode>['ternaryDar...
  function Component (line 5) | function Component() {

FILE: packages/usehooks-ts/src/useTernaryDarkMode/useTernaryDarkMode.ts
  constant COLOR_SCHEME_QUERY (line 6) | const COLOR_SCHEME_QUERY = '(prefers-color-scheme: dark)'
  constant LOCAL_STORAGE_KEY (line 7) | const LOCAL_STORAGE_KEY = 'usehooks-ts-ternary-dark-mode'
  type TernaryDarkMode (line 10) | type TernaryDarkMode = 'system' | 'dark' | 'light'
  type TernaryDarkModeOptions (line 13) | type TernaryDarkModeOptions = {
  type TernaryDarkModeReturn (line 32) | type TernaryDarkModeReturn = {
  function useTernaryDarkMode (line 55) | function useTernaryDarkMode({

FILE: packages/usehooks-ts/src/useTimeout/useTimeout.demo.tsx
  function Component (line 5) | function Component() {

FILE: packages/usehooks-ts/src/useTimeout/useTimeout.ts
  function useTimeout (line 20) | function useTimeout(callback: () => void, delay: number | null): void {

FILE: packages/usehooks-ts/src/useToggle/useToggle.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useToggle/useToggle.ts
  function useToggle (line 20) | function useToggle(

FILE: packages/usehooks-ts/src/useUnmount/useUnmount.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useUnmount/useUnmount.ts
  function useUnmount (line 15) | function useUnmount(func: () => void) {

FILE: packages/usehooks-ts/src/useWindowSize/useWindowSize.demo.tsx
  function Component (line 3) | function Component() {

FILE: packages/usehooks-ts/src/useWindowSize/useWindowSize.ts
  type WindowSize (line 11) | type WindowSize<T extends number | undefined = number | undefined> = {
  type UseWindowSizeOptions (line 22) | type UseWindowSizeOptions<InitializeWithValue extends boolean | undefine...
  constant IS_SERVER (line 35) | const IS_SERVER = typeof window === 'undefined'
  function useWindowSize (line 55) | function useWindowSize(

FILE: packages/usehooks-ts/tests/mocks.ts
  class StorageMock (line 29) | class StorageMock implements Omit<Storage, 'key' | 'length'> {
    method clear (line 32) | clear() {
    method getItem (line 36) | getItem(key: string) {
    method setItem (line 40) | setItem(key: string, value: unknown) {
    method removeItem (line 44) | removeItem(key: string) {

FILE: scripts/update-testing-issue.js
  constant SOURCE_DIR (line 5) | const SOURCE_DIR = path.resolve('./packages/usehooks-ts/src')
  constant GITHUB_REPO (line 6) | const GITHUB_REPO = `juliencrn/usehooks-ts`
  constant GITHUB_ISSUE_PATH (line 7) | const GITHUB_ISSUE_PATH = `${GITHUB_REPO}/issues/423`
  constant EXCLUDED_HOOK (line 8) | const EXCLUDED_HOOK = ['useIsomorphicLayoutEffect']
  function isTestFile (line 48) | function isTestFile(filename) {
  function issueTemplate (line 52) | function issueTemplate(body) {

FILE: scripts/utils/data-transform.js
  function transformImports (line 16) | function transformImports(data) {
  function removeJSDocComments (line 49) | function removeJSDocComments(data) {
  function removeFirstLine (line 60) | function removeFirstLine(data) {
  function removeDefinedInSections (line 69) | function removeDefinedInSections(data) {
  function removeEslintDisableComments (line 88) | function removeEslintDisableComments(data) {
  function camelToKebabCase (line 95) | function camelToKebabCase(str) {
  function replaceRelativePaths (line 99) | function replaceRelativePaths(data) {

FILE: scripts/utils/generate-doc-files.js
  function generateDocFiles (line 17) | function generateDocFiles(hook) {

FILE: scripts/utils/get-hooks.js
  function getHooks (line 4) | function getHooks() {

FILE: scripts/utils/get-markdown-data.js
  function getHookDocData (line 6) | function getHookDocData(hook) {
  function getTypeAliasesData (line 12) | function getTypeAliasesData(hook) {
  function getCodeData (line 23) | function getCodeData(hook) {
  function getDemoData (line 28) | function getDemoData(hook) {
  function getFile (line 36) | function getFile(filename, type) {

FILE: scripts/utils/update-readme.js
  function updateReadme (line 6) | function updateReadme(hooks) {
  function formatHook (line 20) | function formatHook(hook) {