Registry / web-framework / create-history

create-history

library2.1.1jsnpmunverified

A JavaScript library for managing session history in any JavaScript environment. Version 2.1.1 (stable) provides a minimal API to manage the history stack, navigate, confirm navigation, and persist state. It abstracts away differences between browser, Node, and other environments. Key differentiator: it is the core dependency behind React Router v4, offering createHistory, createHashHistory, and createMemoryHistory. Release cadence is infrequent; v2 is stable but superseded by v4 (ESM) and v5 (React Router). Note: This version uses CommonJS; ESM was introduced in later versions.

web-framework http-networking

npm install create-history

github ↗package ↗

INSTALL

IMPORT

SIG · CREATE-HISTORY

create-history

web-frameworkjavascriptv2.1.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createHistory

✓ import { createHistory } from 'history'

✗ import createHistory from 'history' // default export is not createHistory

v2 only has named exports. Default export is the module object.

createHashHistory

✓ import { createHashHistory } from 'history'

✗ var createHashHistory = require('history').createHashHistory // correct but not wrong

Uses browser hash-based routing.

createMemoryHistory

✓ import { createMemoryHistory } from 'history'

✗ import createMemoryHistory from 'history' // wrong: no default export

For non-browser environments like React Native or testing.

useQueries

✓ import { useQueries } from 'history'

✗ const useQueries = require('history/useQueries') // wrong: path does not exist

Deprecated in v2? Not available in v2.1.1 — no such export. Check documentation.

Shows how to create a browser history, listen for location changes, push a new entry, and use memory history in non-browser environments.

const { createHistory, createMemoryHistory } = require('history'); // or use import { createHistory } from 'history' with ESM bundler const history = createHistory(); // browser history // Get the current location const location = history.getCurrentLocation(); console.log(location.pathname); // Listen for changes const unlisten = history.listen((location) => { console.log('New location:', location.pathname); }); // Push a new entry history.push({ pathname: '/new-path', search: '?query=example', state: { user: 'jane' } }); // Stop listening unlisten(); // In Node.js, use memory history: const memoryHistory = createMemoryHistory(); memoryHistory.push('/home');

Debug

Known issues

breakingv2 does not support ESM imports directly; use require or a bundler that handles CommonJS.

fix

Use require() or configure bundler for CommonJS. For ESM, upgrade to v4+.

affects: >=2.0.0 <3.0.0

deprecateduseQueries and useBasename are deprecated in v2; they were removed in later versions.

fix

Avoid using them; they are not present in v2.1.1 final? Actually they were removed earlier. Check docs.

affects: >=2.0.0 <3.0.0

gotchaDefault export from 'history' is the module object, not createHistory. Named exports only.

fix

Use named import: import { createHistory } from 'history'.

affects: >=2.0.0 <3.0.0

gotchacreateHistory() uses window.history; fails in Node.js without polyfill. Use createMemoryHistory instead.

fix

For server-side rendering, use createMemoryHistory or check if window exists.

affects: >=2.0.0

breakingv2 listener signature: (location) => void. In v3+, includes action and other params.

fix

Update listeners when upgrading to v3: (location, action) => void.

affects: >=2.0.0 <3.0.0

Errors

Common errors & fixes

Attempted import error: 'createHistory' is not exported from 'history'.

Trying to import named export from default CommonJS module without proper ESM interop in bundler.

fix

Use require('history').createHistory or configure bundler (e.g., webpack) to handle CommonJS named exports.

history is not defined

Using createHistory() in Node.js environment without browser history API.

fix

Use createMemoryHistory() instead of createHistory() in Node.js.

TypeError: history.listen is not a function

Calling listen on a history object that was not created by createHistory (e.g., using default import).

fix

Ensure you use createHistory (or createMemoryHistory) to create the history object.

Cannot read property 'pathname' of undefined

Trying to access location.pathname before location is defined or inside uninitialized listener.

fix

Check that location is defined: const location = history.getCurrentLocation(); or wait for listener to fire.

Upgrade

Version history

2.1.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

15 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/Lucifier129/history ↗

packagehttps://www.npmjs.com/package/create-history ↗