@fly/cdn/lib/backends/github_pages.d.ts

Fly's TypeScript CDN

/**
 * @module Backends
 */
import { ProxyFunction } from "../proxy";
/**
 * GitHub Repository information.
 */
export interface GitHubPagesOptions {
    /** Repository owner */
    owner: string;
    /** Repository name <repository> format */
    repository: string;
    /** The custom hostname on repository */
    hostname?: string;
}
/**
 * Creates a fetch-like proxy function for making requests to GitHub pages
 * hosted sites.
 *
 * Example:
 *
 * ```typescript
 * import { githubPages } from "./src/backends";
 * const backend = githubPages({
 *  owner: "superfly",
 *  repo: "cdn",
 *  hostname: "docs.fly.io"
 * });
 * ```
 * @param config The Github repository to proxy to
 * @module Backends
 */
export declare function githubPages(options: GitHubPagesOptions | string): ProxyFunction<GitHubPagesOptions>;
export declare namespace githubPages {
    var normalizeOptions: typeof _normalizeOptions;
}
declare function _normalizeOptions(input: unknown): GitHubPagesOptions;
export {};