@types/connect-history-api-fallback
Advanced tools
TypeScript definitions for connect-history-api-fallback
Package description
@types/connect-history-api-fallback provides TypeScript type definitions for the connect-history-api-fallback middleware. This middleware is used in single-page applications (SPAs) to handle the fallback for HTML5 history API, ensuring that the application can handle deep links and refreshes properly by redirecting all non-API requests to the index.html file.
Basic Usage
This code demonstrates the basic usage of the connect-history-api-fallback middleware in an Express application. It sets up the middleware to handle fallback for HTML5 history API and serves static files from the 'public' directory.
const history = require('connect-history-api-fallback');
const express = require('express');
const app = express();
app.use(history());
app.use(express.static('public'));
app.listen(3000, () => {
console.log('Server running on port 3000');
});Custom Options
This code demonstrates how to use the connect-history-api-fallback middleware with custom options. The 'index' option specifies the fallback file, and the 'verbose' option enables logging of the rewrite process.
const history = require('connect-history-api-fallback');
const express = require('express');
const app = express();
const options = {
index: '/index.html',
verbose: true
};
app.use(history(options));
app.use(express.static('public'));
app.listen(3000, () => {
console.log('Server running on port 3000');
});serve-static is a middleware for serving static files in an Express application. While it does not provide HTML5 history API fallback functionality, it is often used in conjunction with connect-history-api-fallback to serve static files after handling the fallback.
express-history-api-fallback is another middleware that provides similar functionality to connect-history-api-fallback. It is specifically designed for use with Express and offers a similar API for handling HTML5 history API fallbacks.
spa-fallback is a lightweight middleware for handling HTML5 history API fallbacks in single-page applications. It is similar to connect-history-api-fallback but offers a simpler API and fewer configuration options.
Readme
npm install --save @types/connect-history-api-fallback
This package contains type definitions for connect-history-api-fallback (https://github.com/bripkens/connect-history-api-fallback#readme).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/connect-history-api-fallback.
/// <reference types="node" />
import { Url } from "url";
import * as core from "express-serve-static-core";
export = historyApiFallback;
declare function historyApiFallback(options?: historyApiFallback.Options): core.RequestHandler;
declare namespace historyApiFallback {
interface Options {
readonly disableDotRule?: true | undefined;
readonly htmlAcceptHeaders?: readonly string[] | undefined;
readonly index?: string | undefined;
readonly logger?: typeof console.log | undefined;
readonly rewrites?: readonly Rewrite[] | undefined;
readonly verbose?: boolean | undefined;
}
interface Context {
readonly match: RegExpMatchArray;
readonly parsedUrl: Url;
readonly request: core.Request;
}
type RewriteTo = (context: Context) => string;
interface Rewrite {
readonly from: RegExp;
readonly to: string | RegExp | RewriteTo;
}
}
These definitions were written by Douglas Duteil.
FAQs
TypeScript definitions for connect-history-api-fallback
The npm package @types/connect-history-api-fallback receives a total of 5,831,638 weekly downloads. As such, @types/connect-history-api-fallback popularity was classified as popular.
We found that @types/connect-history-api-fallback demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.