.
This commit is contained in:
Kismet Hasanaj
@@ -0,0 +1,5 @@
|
|||||||
|
<!-- BEGIN:nextjs-agent-rules -->
|
||||||
|
# This is NOT the Next.js you know
|
||||||
|
|
||||||
|
This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in `node_modules/next/dist/docs/` before writing any code. Heed deprecation notices.
|
||||||
|
<!-- END:nextjs-agent-rules -->
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
"use client";
|
||||||
|
|
||||||
|
import { useEffect } from "react";
|
||||||
|
|
||||||
|
export default function Error({
|
||||||
|
error,
|
||||||
|
unstable_retry,
|
||||||
|
}: {
|
||||||
|
error: Error & { digest?: string };
|
||||||
|
unstable_retry: () => void;
|
||||||
|
}) {
|
||||||
|
useEffect(() => {
|
||||||
|
console.error(error);
|
||||||
|
}, [error]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<main className="site-shell">
|
||||||
|
<section className="hero" aria-labelledby="error-heading">
|
||||||
|
<div className="container">
|
||||||
|
<div className="hero-copy">
|
||||||
|
<p className="eyebrow" aria-hidden="true">
|
||||||
|
Error
|
||||||
|
</p>
|
||||||
|
<h1 id="error-heading">Something went wrong</h1>
|
||||||
|
<p className="hero-text">
|
||||||
|
An unexpected error occurred. Please try again, or contact us at{" "}
|
||||||
|
<a href="mailto:contact@novarixnet.com" style={{ color: "var(--accent)" }}>
|
||||||
|
contact@novarixnet.com
|
||||||
|
</a>{" "}
|
||||||
|
if the problem persists.
|
||||||
|
</p>
|
||||||
|
<div className="hero-actions">
|
||||||
|
<button className="button button-primary" onClick={unstable_retry}>
|
||||||
|
Try again
|
||||||
|
</button>
|
||||||
|
<a href="/" className="button button-secondary">
|
||||||
|
Go home
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
);
|
||||||
|
}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
+1088
File diff suppressed because it is too large
Load Diff
+162
@@ -0,0 +1,162 @@
|
|||||||
|
/**
|
||||||
|
* layout.tsx — Root layout for Novarix Networks
|
||||||
|
*
|
||||||
|
* Responsible for:
|
||||||
|
* • Loading "DM Sans" via next/font/google (self-hosted, zero CLS).
|
||||||
|
* • Applying global CSS (globals.css).
|
||||||
|
* • Exporting page-level metadata for <head> injection, Open Graph, and
|
||||||
|
* Twitter card meta.
|
||||||
|
* • Setting viewport and theme-colour meta tags.
|
||||||
|
* • Injecting JSON-LD Organisation structured data for rich search results.
|
||||||
|
*
|
||||||
|
* ─── Adding pages ────────────────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* New pages created under /app inherit this layout automatically.
|
||||||
|
* To create a nested layout (e.g. for a /services sub-section), add a
|
||||||
|
* layout.tsx inside /app/services/ — Next.js will compose them.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { Metadata, Viewport } from "next";
|
||||||
|
import { DM_Sans } from "next/font/google";
|
||||||
|
import "./globals.css";
|
||||||
|
|
||||||
|
/* ── Font ──────────────────────────────────────────────────────────────── */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DM Sans loaded via next/font/google.
|
||||||
|
* The font is downloaded at build time and served from /_next/static/media/
|
||||||
|
* — no third-party request at runtime, eliminating the CLS caused by
|
||||||
|
* loading from fonts.googleapis.com.
|
||||||
|
*
|
||||||
|
* `variable` exposes the font as a CSS custom property (--font-dm-sans)
|
||||||
|
* so globals.css can reference it without importing from JS.
|
||||||
|
*/
|
||||||
|
const dmSans = DM_Sans({
|
||||||
|
subsets: ["latin"],
|
||||||
|
variable: "--font-dm-sans",
|
||||||
|
display: "swap",
|
||||||
|
});
|
||||||
|
|
||||||
|
/* ── JSON-LD structured data ───────────────────────────────────────────── */
|
||||||
|
|
||||||
|
const jsonLd = {
|
||||||
|
"@context": "https://schema.org",
|
||||||
|
"@type": "Organization",
|
||||||
|
name: "Novarix Networks",
|
||||||
|
url: "https://novarixnet.com",
|
||||||
|
email: "contact@novarixnet.com",
|
||||||
|
description:
|
||||||
|
"Novarix Networks provides business connectivity, managed network services, and transit-focused infrastructure support for organisations that need dependable engineering and clear technical ownership.",
|
||||||
|
knowsAbout: [
|
||||||
|
"Business Connectivity",
|
||||||
|
"Managed Network Services",
|
||||||
|
"IP Transit",
|
||||||
|
"Peering",
|
||||||
|
"BGP",
|
||||||
|
"Network Engineering",
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
/* ── Site metadata ─────────────────────────────────────────────────────── */
|
||||||
|
|
||||||
|
export const metadata: Metadata = {
|
||||||
|
/**
|
||||||
|
* metadataBase resolves relative URLs in metadata fields (e.g. OG images).
|
||||||
|
* Pull from an environment variable per-environment if needed:
|
||||||
|
*
|
||||||
|
* metadataBase: new URL(process.env.NEXT_PUBLIC_SITE_URL ?? "https://novarixnet.com"),
|
||||||
|
*/
|
||||||
|
metadataBase: new URL("https://novarixnet.com"),
|
||||||
|
|
||||||
|
title: {
|
||||||
|
default: "Novarix Networks",
|
||||||
|
template: "%s | Novarix Networks",
|
||||||
|
},
|
||||||
|
|
||||||
|
description:
|
||||||
|
"Novarix Networks provides business connectivity, managed network services, and transit-focused infrastructure support for organisations that need dependable engineering and clear technical ownership.",
|
||||||
|
|
||||||
|
applicationName: "Novarix Networks",
|
||||||
|
|
||||||
|
keywords: [
|
||||||
|
"Novarix Networks",
|
||||||
|
"ISP",
|
||||||
|
"Managed Service Provider",
|
||||||
|
"MSP",
|
||||||
|
"IP Transit",
|
||||||
|
"Business Connectivity",
|
||||||
|
"Peering",
|
||||||
|
"BGP",
|
||||||
|
"IXP",
|
||||||
|
"CDN Edge",
|
||||||
|
"Network Engineering",
|
||||||
|
],
|
||||||
|
|
||||||
|
authors: [{ name: "Novarix Networks" }],
|
||||||
|
creator: "Novarix Networks",
|
||||||
|
publisher: "Novarix Networks",
|
||||||
|
|
||||||
|
alternates: {
|
||||||
|
canonical: "/",
|
||||||
|
},
|
||||||
|
|
||||||
|
openGraph: {
|
||||||
|
type: "website",
|
||||||
|
url: "https://novarixnet.com",
|
||||||
|
siteName: "Novarix Networks",
|
||||||
|
title: "Novarix Networks",
|
||||||
|
description:
|
||||||
|
"Business connectivity, managed network services, transit, and engineering-led infrastructure support.",
|
||||||
|
locale: "en_GB",
|
||||||
|
/*
|
||||||
|
* Add a 1200 × 630 px image to /public/og-image.png to enable rich
|
||||||
|
* link previews on LinkedIn, Slack, and Facebook:
|
||||||
|
*
|
||||||
|
* images: [{ url: "/og-image.png", width: 1200, height: 630 }],
|
||||||
|
*/
|
||||||
|
},
|
||||||
|
|
||||||
|
twitter: {
|
||||||
|
card: "summary_large_image",
|
||||||
|
title: "Novarix Networks",
|
||||||
|
description:
|
||||||
|
"Business connectivity, managed network services, transit, and engineering-led infrastructure support.",
|
||||||
|
/*
|
||||||
|
* images: ["/og-image.png"],
|
||||||
|
*/
|
||||||
|
},
|
||||||
|
|
||||||
|
robots: {
|
||||||
|
index: true,
|
||||||
|
follow: true,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
/* ── Viewport & theme colour ───────────────────────────────────────────── */
|
||||||
|
|
||||||
|
export const viewport: Viewport = {
|
||||||
|
width: "device-width",
|
||||||
|
initialScale: 1,
|
||||||
|
themeColor: [
|
||||||
|
{ media: "(prefers-color-scheme: light)", color: "#ffffff" },
|
||||||
|
{ media: "(prefers-color-scheme: dark)", color: "#020617" },
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
/* ── Root layout component ─────────────────────────────────────────────── */
|
||||||
|
|
||||||
|
export default function RootLayout({
|
||||||
|
children,
|
||||||
|
}: Readonly<{ children: React.ReactNode }>) {
|
||||||
|
return (
|
||||||
|
<html lang="en-GB" suppressHydrationWarning className={dmSans.variable}>
|
||||||
|
<head>
|
||||||
|
<script
|
||||||
|
type="application/ld+json"
|
||||||
|
dangerouslySetInnerHTML={{ __html: JSON.stringify(jsonLd) }}
|
||||||
|
/>
|
||||||
|
</head>
|
||||||
|
<body>{children}</body>
|
||||||
|
</html>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import Link from "next/link";
|
||||||
|
import type { Metadata } from "next";
|
||||||
|
|
||||||
|
export const metadata: Metadata = {
|
||||||
|
title: "Page Not Found",
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function NotFound() {
|
||||||
|
return (
|
||||||
|
<main className="site-shell">
|
||||||
|
<section className="hero" aria-labelledby="notfound-heading">
|
||||||
|
<div className="container">
|
||||||
|
<div className="hero-copy">
|
||||||
|
<p className="eyebrow" aria-hidden="true">
|
||||||
|
404
|
||||||
|
</p>
|
||||||
|
<h1 id="notfound-heading">Page not found</h1>
|
||||||
|
<p className="hero-text">
|
||||||
|
The page you’re looking for doesn’t exist or has been
|
||||||
|
moved.
|
||||||
|
</p>
|
||||||
|
<div className="hero-actions">
|
||||||
|
<Link href="/" className="button button-primary">
|
||||||
|
Go home
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
);
|
||||||
|
}
|
||||||
+540
@@ -0,0 +1,540 @@
|
|||||||
|
/**
|
||||||
|
* page.tsx — Novarix Networks home page
|
||||||
|
*
|
||||||
|
* This is the only route in the site ("/"). It renders a single-page layout
|
||||||
|
* with the following sections:
|
||||||
|
*
|
||||||
|
* 1. Intro overlay — first-visit only splash (Lottie + wordmark)
|
||||||
|
* 2. Header — sticky nav with brand wordmark
|
||||||
|
* 3. Hero — headline, sub-text, CTA buttons
|
||||||
|
* 4. Services — three service cards
|
||||||
|
* 5. Direction — three-phase platform roadmap
|
||||||
|
* 6. Contact — mailto link
|
||||||
|
* 7. Footer — copyright line
|
||||||
|
*
|
||||||
|
* ─── State overview ──────────────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* showIntro Controls whether the splash overlay is rendered. Starts
|
||||||
|
* false (SSR safe), is set to true on first mount if the
|
||||||
|
* "novarix-intro-seen" sessionStorage key is absent, then
|
||||||
|
* reverts to false after the intro duration elapses.
|
||||||
|
*
|
||||||
|
* mounted Prevents the intro overlay from rendering during SSR / the
|
||||||
|
* hydration pass, which would cause a server/client mismatch.
|
||||||
|
*
|
||||||
|
* pointer Tracks normalised cursor position (0–100 %) for the ambient
|
||||||
|
* radial-gradient background effect.
|
||||||
|
*
|
||||||
|
* ─── Adding / editing content ────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* • Update the `services` array to change service cards.
|
||||||
|
* • Update the direction items inline in the JSX.
|
||||||
|
* • The intro animation JSON lives at /public/branding/animated_logo_intro.json
|
||||||
|
* • Wordmark images live at /public/branding/novarix-wordmark-{colour,white}.png
|
||||||
|
*
|
||||||
|
* ─── Dependencies ────────────────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* next/image — optimised image component (lazy-loading, AVIF/WebP)
|
||||||
|
* lottie-react — renders the Bodymovin / Lottie JSON animation
|
||||||
|
*
|
||||||
|
* Install lottie-react if not already present:
|
||||||
|
* npm install lottie-react
|
||||||
|
*/
|
||||||
|
|
||||||
|
"use client";
|
||||||
|
|
||||||
|
import Image from "next/image";
|
||||||
|
import dynamic from "next/dynamic";
|
||||||
|
import { useEffect, useMemo, useRef, useState } from "react";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lottie is dynamically imported so neither the library (~150 KB) nor the
|
||||||
|
* animation JSON (261 KB) are included in the initial page bundle. They are
|
||||||
|
* fetched only on first visit when the intro overlay is needed.
|
||||||
|
*/
|
||||||
|
const Lottie = dynamic(() => import("lottie-react"), { ssr: false });
|
||||||
|
|
||||||
|
/* ── Service card data ─────────────────────────────────────────────────── */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Each entry renders one card in the Services section.
|
||||||
|
* Add, remove, or reorder entries here without touching the JSX.
|
||||||
|
*
|
||||||
|
* Fields:
|
||||||
|
* title — card heading
|
||||||
|
* description — body copy (2–3 sentences recommended)
|
||||||
|
* icon — Unicode emoji or inline SVG string used as the card icon
|
||||||
|
*/
|
||||||
|
const services = [
|
||||||
|
{
|
||||||
|
eyebrow: "ISP",
|
||||||
|
title: "Business Connectivity",
|
||||||
|
description:
|
||||||
|
"Routed internet access for organisations that need clear ownership, static addressing, and a provider willing to talk through the real topology.",
|
||||||
|
points: ["Business internet access", "Static IP addressing", "Routed handoff options"],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
eyebrow: "MSP",
|
||||||
|
title: "Managed Network Services",
|
||||||
|
description:
|
||||||
|
"Managed edge, routing, firewall, and switching support for teams that want stronger control without carrying every operational detail alone.",
|
||||||
|
points: ["Managed edge infrastructure", "Change and migration support", "Operational visibility"],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
eyebrow: "Transit",
|
||||||
|
title: "Transit and Interconnect",
|
||||||
|
description:
|
||||||
|
"Transit and interconnection planning for operators, platforms, and technical environments where routing posture matters.",
|
||||||
|
points: ["IP transit readiness", "Peering strategy", "Carrier engagement"],
|
||||||
|
},
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
const networkSignals = [
|
||||||
|
{ label: "Operating focus", value: "ISP / MSP / Transit" },
|
||||||
|
{ label: "Designed for", value: "Business-critical networks" },
|
||||||
|
{ label: "Built around", value: "Practical engineering" },
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
const platformPhases = [
|
||||||
|
{
|
||||||
|
phase: "Phase 1",
|
||||||
|
title: "Connectivity and managed support",
|
||||||
|
description:
|
||||||
|
"Lead with services that can be delivered credibly from day one: internet access, managed network support, and engineering advisory work.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
phase: "Phase 2",
|
||||||
|
title: "Transit, peering, and interconnect",
|
||||||
|
description:
|
||||||
|
"Grow toward exchange participation, partner interconnection, and clearer transit propositions as the network footprint matures.",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
phase: "Phase 3",
|
||||||
|
title: "Selective edge infrastructure",
|
||||||
|
description:
|
||||||
|
"Introduce regional edge or platform capability only where real demand, operational control, and commercial return justify it.",
|
||||||
|
},
|
||||||
|
] as const;
|
||||||
|
|
||||||
|
/* ── Types ─────────────────────────────────────────────────────────────── */
|
||||||
|
|
||||||
|
type PointerState = {
|
||||||
|
x: number; // cursor X as percentage of viewport width (0–100)
|
||||||
|
y: number; // cursor Y as percentage of viewport height (0–100)
|
||||||
|
};
|
||||||
|
|
||||||
|
/* ── Constants ─────────────────────────────────────────────────────────── */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Total duration the intro overlay is visible (milliseconds).
|
||||||
|
* Must be long enough to cover:
|
||||||
|
* • Lottie animation length
|
||||||
|
* • Wordmark slide-in (350 ms delay + ~1 000 ms animation = ~1 350 ms)
|
||||||
|
* • CSS fade-out at 2 450 ms (620 ms duration)
|
||||||
|
*
|
||||||
|
* The JS timer uses 3 200 ms so it matches the full CSS sequence before
|
||||||
|
* React removes the overlay from the DOM.
|
||||||
|
*/
|
||||||
|
const INTRO_DURATION_MS = 3200;
|
||||||
|
|
||||||
|
/** sessionStorage key used to gate the intro to one play per browser tab */
|
||||||
|
const INTRO_STORAGE_KEY = "novarix-intro-seen";
|
||||||
|
|
||||||
|
/* ── Component ─────────────────────────────────────────────────────────── */
|
||||||
|
|
||||||
|
export default function HomePage() {
|
||||||
|
// Prevents intro from rendering during SSR / hydration mismatch
|
||||||
|
const [mounted, setMounted] = useState(false);
|
||||||
|
|
||||||
|
// Whether to show the intro overlay
|
||||||
|
const [showIntro, setShowIntro] = useState(false);
|
||||||
|
|
||||||
|
// Lazily-loaded Lottie animation data (null until fetched)
|
||||||
|
const [introAnimation, setIntroAnimation] = useState<Record<string, unknown> | null>(null);
|
||||||
|
|
||||||
|
// Normalised cursor position for the ambient gradient
|
||||||
|
const [pointer, setPointer] = useState<PointerState>({ x: 50, y: 22 });
|
||||||
|
|
||||||
|
// Ref to the Lottie instance — can be used to imperatively control playback
|
||||||
|
const lottieRef = useRef(null);
|
||||||
|
|
||||||
|
/* ── Side effects ── */
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
setMounted(true);
|
||||||
|
|
||||||
|
let timer: number | undefined;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const introSeen = window.sessionStorage.getItem(INTRO_STORAGE_KEY);
|
||||||
|
|
||||||
|
if (!introSeen) {
|
||||||
|
window.sessionStorage.setItem(INTRO_STORAGE_KEY, "true");
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Dynamically import the 261 KB animation JSON only on first visit.
|
||||||
|
* This keeps it out of the initial page bundle entirely.
|
||||||
|
*/
|
||||||
|
import("@/public/branding/animated_logo_intro.json").then((mod) => {
|
||||||
|
setIntroAnimation(mod.default as Record<string, unknown>);
|
||||||
|
setShowIntro(true);
|
||||||
|
timer = window.setTimeout(() => setShowIntro(false), INTRO_DURATION_MS);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
/*
|
||||||
|
* sessionStorage may be unavailable (private browsing restrictions,
|
||||||
|
* storage quota exceeded, or cross-origin iframes). Silently skip
|
||||||
|
* the intro rather than crashing.
|
||||||
|
*/
|
||||||
|
}
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
if (timer) window.clearTimeout(timer);
|
||||||
|
};
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
/* ── Derived values ── */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Memoised inline style object for the ambient background.
|
||||||
|
* Only recalculated when pointer.x or pointer.y change, preventing
|
||||||
|
* object identity churn on every render.
|
||||||
|
*/
|
||||||
|
const backgroundStyle = useMemo<React.CSSProperties>(
|
||||||
|
() => ({
|
||||||
|
"--mx": `${pointer.x}%`,
|
||||||
|
"--my": `${pointer.y}%`,
|
||||||
|
} as React.CSSProperties),
|
||||||
|
[pointer.x, pointer.y]
|
||||||
|
);
|
||||||
|
|
||||||
|
/* ── Handlers ── */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the pointer state on mouse movement.
|
||||||
|
* Coordinates are normalised to the bounding rect of the main element
|
||||||
|
* (rather than the window) to avoid edge cases near fixed headers.
|
||||||
|
*/
|
||||||
|
function handleMouseMove(event: React.MouseEvent<HTMLElement>) {
|
||||||
|
const rect = event.currentTarget.getBoundingClientRect();
|
||||||
|
setPointer({
|
||||||
|
x: ((event.clientX - rect.left) / rect.width) * 100,
|
||||||
|
y: ((event.clientY - rect.top) / rect.height) * 100,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ── Render ── */
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
{/* ── Intro overlay ───────────────────────────────────────────────
|
||||||
|
Rendered only:
|
||||||
|
(a) after hydration (`mounted`)
|
||||||
|
(b) on the first visit within the session (`showIntro`)
|
||||||
|
|
||||||
|
aria-hidden="true" hides it from screen readers; the main content
|
||||||
|
is focusable without waiting for the intro to finish.
|
||||||
|
─────────────────────────────────────────────────────────────────── */}
|
||||||
|
{mounted && showIntro && (
|
||||||
|
<div className="intro-overlay" aria-hidden="true">
|
||||||
|
<div className="intro-backdrop" />
|
||||||
|
|
||||||
|
<div className="intro-shell">
|
||||||
|
{/* Lottie logo animation — renders once animationData has loaded */}
|
||||||
|
<div className="intro-lottie-wrap">
|
||||||
|
{introAnimation && (
|
||||||
|
<Lottie
|
||||||
|
lottieRef={lottieRef}
|
||||||
|
animationData={introAnimation}
|
||||||
|
loop={false}
|
||||||
|
autoplay
|
||||||
|
className="intro-lottie"
|
||||||
|
rendererSettings={{
|
||||||
|
preserveAspectRatio: "xMidYMid meet",
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* Wordmark — colour in light mode, white in dark mode */}
|
||||||
|
<div className="intro-wordmark-wrap">
|
||||||
|
<Image
|
||||||
|
src="/branding/novarix-wordmark-colour.png"
|
||||||
|
alt="Novarix Networks"
|
||||||
|
width={2048}
|
||||||
|
height={430}
|
||||||
|
sizes="(max-width: 720px) 86vw, (max-width: 980px) 72vw, 864px"
|
||||||
|
className="intro-wordmark intro-wordmark-light"
|
||||||
|
/>
|
||||||
|
<Image
|
||||||
|
src="/branding/novarix-wordmark-white.png"
|
||||||
|
alt="Novarix Networks"
|
||||||
|
width={2048}
|
||||||
|
height={430}
|
||||||
|
sizes="(max-width: 720px) 86vw, (max-width: 980px) 72vw, 864px"
|
||||||
|
className="intro-wordmark intro-wordmark-dark"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{/* ── Page shell ──────────────────────────────────────────────────
|
||||||
|
`intro-running` class hides section content while the intro
|
||||||
|
overlay is active, preventing a flash of content beneath it.
|
||||||
|
─────────────────────────────────────────────────────────────────── */}
|
||||||
|
<main
|
||||||
|
id="top"
|
||||||
|
className={`site-shell${showIntro ? " intro-running" : ""}`}
|
||||||
|
style={backgroundStyle}
|
||||||
|
onMouseMove={handleMouseMove}
|
||||||
|
>
|
||||||
|
{/* ── Ambient decorative layer (aria-hidden) ─────────────────── */}
|
||||||
|
<div className="ambient-layer" aria-hidden="true">
|
||||||
|
<div className="ambient-orb ambient-orb-a" />
|
||||||
|
<div className="ambient-orb ambient-orb-b" />
|
||||||
|
<div className="ambient-grid" />
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* ════════════════════════════════════════════════════════════
|
||||||
|
HEADER
|
||||||
|
════════════════════════════════════════════════════════════ */}
|
||||||
|
<header className="site-header">
|
||||||
|
<div className="container header-inner">
|
||||||
|
{/* Brand wordmark — links back to the top of the page */}
|
||||||
|
<a href="#top" className="brand-link" aria-label="Novarix Networks — go to top">
|
||||||
|
<Image
|
||||||
|
src="/branding/novarix-wordmark-colour.png"
|
||||||
|
alt="Novarix Networks"
|
||||||
|
width={2048}
|
||||||
|
height={430}
|
||||||
|
priority
|
||||||
|
sizes="(max-width: 560px) 50vw, (max-width: 720px) 54vw, (max-width: 980px) 45vw, 250px"
|
||||||
|
className="brand-image brand-image-light"
|
||||||
|
/>
|
||||||
|
<Image
|
||||||
|
src="/branding/novarix-wordmark-white.png"
|
||||||
|
alt="Novarix Networks"
|
||||||
|
width={2048}
|
||||||
|
height={430}
|
||||||
|
priority
|
||||||
|
sizes="(max-width: 560px) 50vw, (max-width: 720px) 54vw, (max-width: 980px) 45vw, 250px"
|
||||||
|
className="brand-image brand-image-dark"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
{/* Primary navigation */}
|
||||||
|
<nav className="nav" aria-label="Primary navigation">
|
||||||
|
<a href="#services">Services</a>
|
||||||
|
<a href="#network">Network</a>
|
||||||
|
<a href="#direction">Direction</a>
|
||||||
|
<a href="#contact">Contact</a>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
{/* ════════════════════════════════════════════════════════════
|
||||||
|
HERO
|
||||||
|
════════════════════════════════════════════════════════════ */}
|
||||||
|
<section className="hero" aria-labelledby="hero-heading">
|
||||||
|
<div className="hero-mark" aria-hidden="true" />
|
||||||
|
<div className="container">
|
||||||
|
<div className="hero-copy">
|
||||||
|
<p className="eyebrow" aria-hidden="true">
|
||||||
|
Independent ISP · Managed Services · Transit
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h1 id="hero-heading">
|
||||||
|
Agile network infrastructure for organisations that cannot wait on slow providers.
|
||||||
|
</h1>
|
||||||
|
|
||||||
|
<p className="hero-text">
|
||||||
|
Novarix Networks is being built as an engineering-led ISP, MSP,
|
||||||
|
and transit provider for businesses, operators, and demanding
|
||||||
|
projects that need direct answers, dependable routing, and room
|
||||||
|
to grow.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<div className="hero-actions">
|
||||||
|
<a href="#contact" className="button button-primary">
|
||||||
|
Discuss a requirement
|
||||||
|
</a>
|
||||||
|
<a href="#services" className="button button-secondary">
|
||||||
|
Explore services
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="signal-strip" aria-label="Novarix Networks positioning">
|
||||||
|
{networkSignals.map((signal) => (
|
||||||
|
<div key={signal.label} className="signal-item">
|
||||||
|
<span>{signal.label}</span>
|
||||||
|
<strong>{signal.value}</strong>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section className="statement-section section-border" aria-label="Company statement">
|
||||||
|
<div className="container">
|
||||||
|
<p>
|
||||||
|
Novarix exists for the moments where connectivity is not a commodity purchase:
|
||||||
|
new sites, awkward migrations, routed environments, managed edge,
|
||||||
|
transit conversations, and the technical work that sits between them.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
{/* ════════════════════════════════════════════════════════════
|
||||||
|
SERVICES
|
||||||
|
To add a service, append an entry to the `services` array
|
||||||
|
at the top of this file.
|
||||||
|
════════════════════════════════════════════════════════════ */}
|
||||||
|
<section
|
||||||
|
id="services"
|
||||||
|
className="section section-border"
|
||||||
|
aria-labelledby="services-heading"
|
||||||
|
>
|
||||||
|
<div className="container">
|
||||||
|
<div className="section-heading">
|
||||||
|
<h2 id="services-heading">Services</h2>
|
||||||
|
<p>
|
||||||
|
A focused offer for customers who need practical delivery now,
|
||||||
|
with a network strategy that can deepen over time.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="card-grid">
|
||||||
|
{services.map((service) => (
|
||||||
|
<article key={service.title} className="card">
|
||||||
|
<span className="card-eyebrow">{service.eyebrow}</span>
|
||||||
|
<h3>{service.title}</h3>
|
||||||
|
<p>{service.description}</p>
|
||||||
|
<ul className="card-points">
|
||||||
|
{service.points.map((point) => (
|
||||||
|
<li key={point}>{point}</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</article>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section
|
||||||
|
id="network"
|
||||||
|
className="network-section section-border"
|
||||||
|
aria-labelledby="network-heading"
|
||||||
|
>
|
||||||
|
<div className="container network-layout">
|
||||||
|
<div className="section-heading">
|
||||||
|
<h2 id="network-heading">Built for the current climate of networking.</h2>
|
||||||
|
<p>
|
||||||
|
The site should signal that Novarix is technical, independent,
|
||||||
|
and pragmatic: capable of working across access, managed
|
||||||
|
services, transit, and the messy edges where real networks live.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="network-stack" aria-label="Network operating principles">
|
||||||
|
<div className="network-stack-item">
|
||||||
|
<span>01</span>
|
||||||
|
<strong>Direct technical conversation</strong>
|
||||||
|
<p>Requirements are shaped with the people who understand routing, handoff, risk, and operational reality.</p>
|
||||||
|
</div>
|
||||||
|
<div className="network-stack-item">
|
||||||
|
<span>02</span>
|
||||||
|
<strong>Lean delivery model</strong>
|
||||||
|
<p>Keep the path between problem, decision, and change short enough to stay useful.</p>
|
||||||
|
</div>
|
||||||
|
<div className="network-stack-item">
|
||||||
|
<span>03</span>
|
||||||
|
<strong>Expansion without theatre</strong>
|
||||||
|
<p>Grow into peering, transit, and edge services when the demand and network maturity support it.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
{/* ════════════════════════════════════════════════════════════
|
||||||
|
PLATFORM DIRECTION
|
||||||
|
Three-phase roadmap. Edit phases inline below.
|
||||||
|
════════════════════════════════════════════════════════════ */}
|
||||||
|
<section
|
||||||
|
id="direction"
|
||||||
|
className="section section-border"
|
||||||
|
aria-labelledby="direction-heading"
|
||||||
|
>
|
||||||
|
<div className="container narrow">
|
||||||
|
<div className="section-heading">
|
||||||
|
<h2 id="direction-heading">Platform Direction</h2>
|
||||||
|
<p>
|
||||||
|
The public message stays credible today while leaving a clear
|
||||||
|
route toward deeper interconnection and operator-grade services.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className="direction-list">
|
||||||
|
{platformPhases.map((item) => (
|
||||||
|
<div className="direction-item" key={item.phase}>
|
||||||
|
<span className="direction-phase">{item.phase}</span>
|
||||||
|
<h3>{item.title}</h3>
|
||||||
|
<p>{item.description}</p>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
{/* ════════════════════════════════════════════════════════════
|
||||||
|
CONTACT
|
||||||
|
Update the mailto address and any supporting copy here.
|
||||||
|
════════════════════════════════════════════════════════════ */}
|
||||||
|
<section
|
||||||
|
id="contact"
|
||||||
|
className="section section-border"
|
||||||
|
aria-labelledby="contact-heading"
|
||||||
|
>
|
||||||
|
<div className="container narrow">
|
||||||
|
<div className="section-heading">
|
||||||
|
<h2 id="contact-heading">Contact</h2>
|
||||||
|
<p>
|
||||||
|
For connectivity, managed networking, transit, or early project
|
||||||
|
discussions, start with a direct email. Keep it technical if
|
||||||
|
that is what the requirement needs.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<a
|
||||||
|
className="contact-link"
|
||||||
|
href="mailto:contact@novarixnet.com"
|
||||||
|
aria-label="Send an email to contact@novarixnet.com"
|
||||||
|
>
|
||||||
|
contact@novarixnet.com
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
{/* ════════════════════════════════════════════════════════════
|
||||||
|
FOOTER
|
||||||
|
════════════════════════════════════════════════════════════ */}
|
||||||
|
<footer className="footer section-border">
|
||||||
|
<div className="container footer-inner">
|
||||||
|
<span>
|
||||||
|
© {new Date().getFullYear()} Novarix Networks Limited
|
||||||
|
</span>
|
||||||
|
|
||||||
|
{/*
|
||||||
|
* Optional: add secondary footer links here, e.g.:
|
||||||
|
* <nav aria-label="Footer navigation">
|
||||||
|
* <a href="/privacy">Privacy</a>
|
||||||
|
* </nav>
|
||||||
|
*/}
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
</main>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
/**
|
||||||
|
* robots.ts — Robots.txt generation for Novarix Networks
|
||||||
|
*
|
||||||
|
* Next.js App Router generates /robots.txt automatically from the object
|
||||||
|
* returned by this default export.
|
||||||
|
*
|
||||||
|
* ─── Notes ───────────────────────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* • The `sitemap` field should match the canonical domain. If the domain
|
||||||
|
* ever changes, update both this file and sitemap.ts.
|
||||||
|
*
|
||||||
|
* • To block specific paths (e.g. staging pages or admin routes), add
|
||||||
|
* `disallow` entries to the rules array:
|
||||||
|
*
|
||||||
|
* rules: [
|
||||||
|
* { userAgent: "*", allow: "/", disallow: ["/admin/", "/staging/"] },
|
||||||
|
* ],
|
||||||
|
*
|
||||||
|
* • To block a specific crawler entirely:
|
||||||
|
*
|
||||||
|
* rules: [
|
||||||
|
* { userAgent: "*", allow: "/" },
|
||||||
|
* { userAgent: "GPTBot", disallow: "/" },
|
||||||
|
* ],
|
||||||
|
*
|
||||||
|
* ─── Output ──────────────────────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* User-agent: *
|
||||||
|
* Allow: /
|
||||||
|
* Sitemap: https://novarixnet.com/sitemap.xml
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { MetadataRoute } from "next";
|
||||||
|
|
||||||
|
export default function robots(): MetadataRoute.Robots {
|
||||||
|
return {
|
||||||
|
rules: {
|
||||||
|
userAgent: "*",
|
||||||
|
allow: "/",
|
||||||
|
},
|
||||||
|
sitemap: "https://novarixnet.com/sitemap.xml",
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
/**
|
||||||
|
* sitemap.ts — XML sitemap generation for Novarix Networks
|
||||||
|
*
|
||||||
|
* Next.js App Router generates /sitemap.xml automatically from the array
|
||||||
|
* returned by this default export.
|
||||||
|
*
|
||||||
|
* ─── Adding pages ────────────────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* Append an entry for each publicly reachable page:
|
||||||
|
*
|
||||||
|
* {
|
||||||
|
* url: "https://novarixnet.com/services",
|
||||||
|
* lastModified: new Date("2025-06-01"),
|
||||||
|
* changeFrequency: "monthly",
|
||||||
|
* priority: 0.8,
|
||||||
|
* },
|
||||||
|
*
|
||||||
|
* `lastModified` can be a Date object or an ISO 8601 string.
|
||||||
|
* `priority` is a hint (0.0–1.0) for search engine crawl budgeting.
|
||||||
|
*
|
||||||
|
* ─── Dynamic routes ──────────────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* For blog posts or product pages generated from a CMS, fetch slugs inside
|
||||||
|
* this function and map them to sitemap entries:
|
||||||
|
*
|
||||||
|
* const posts = await fetchPosts();
|
||||||
|
* return posts.map((p) => ({
|
||||||
|
* url: `https://novarixnet.com/blog/${p.slug}`,
|
||||||
|
* lastModified: p.updatedAt,
|
||||||
|
* changeFrequency: "weekly",
|
||||||
|
* priority: 0.6,
|
||||||
|
* }));
|
||||||
|
*
|
||||||
|
* ─── Output ──────────────────────────────────────────────────────────────
|
||||||
|
*
|
||||||
|
* <?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
* <urlset xmlns="https://www.sitemaps.org/schemas/sitemap/0.9">
|
||||||
|
* <url>
|
||||||
|
* <loc>https://novarixnet.com</loc>
|
||||||
|
* <lastmod>…</lastmod>
|
||||||
|
* <changefreq>monthly</changefreq>
|
||||||
|
* <priority>1</priority>
|
||||||
|
* </url>
|
||||||
|
* </urlset>
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { MetadataRoute } from "next";
|
||||||
|
|
||||||
|
export default function sitemap(): MetadataRoute.Sitemap {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
url: "https://novarixnet.com",
|
||||||
|
lastModified: new Date(),
|
||||||
|
changeFrequency: "monthly",
|
||||||
|
priority: 1,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import { defineConfig, globalIgnores } from "eslint/config";
|
||||||
|
import nextVitals from "eslint-config-next/core-web-vitals";
|
||||||
|
import nextTs from "eslint-config-next/typescript";
|
||||||
|
|
||||||
|
const eslintConfig = defineConfig([
|
||||||
|
...nextVitals,
|
||||||
|
...nextTs,
|
||||||
|
// Override default ignores of eslint-config-next.
|
||||||
|
globalIgnores([
|
||||||
|
// Default ignores of eslint-config-next:
|
||||||
|
".next/**",
|
||||||
|
"out/**",
|
||||||
|
"build/**",
|
||||||
|
"next-env.d.ts",
|
||||||
|
]),
|
||||||
|
]);
|
||||||
|
|
||||||
|
export default eslintConfig;
|
||||||
Vendored
+6
@@ -0,0 +1,6 @@
|
|||||||
|
/// <reference types="next" />
|
||||||
|
/// <reference types="next/image-types/global" />
|
||||||
|
import "./.next/dev/types/routes.d.ts";
|
||||||
|
|
||||||
|
// NOTE: This file should not be edited
|
||||||
|
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
import type { NextConfig } from "next";
|
||||||
|
|
||||||
|
const securityHeaders = [
|
||||||
|
{ key: "X-Frame-Options", value: "DENY" },
|
||||||
|
{ key: "X-Content-Type-Options", value: "nosniff" },
|
||||||
|
{ key: "Referrer-Policy", value: "strict-origin-when-cross-origin" },
|
||||||
|
{ key: "Permissions-Policy", value: "camera=(), microphone=(), geolocation=()" },
|
||||||
|
{
|
||||||
|
key: "Strict-Transport-Security",
|
||||||
|
value: "max-age=63072000; includeSubDomains; preload",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: "Content-Security-Policy",
|
||||||
|
value: [
|
||||||
|
"default-src 'self'",
|
||||||
|
"script-src 'self' 'unsafe-inline'",
|
||||||
|
"style-src 'self' 'unsafe-inline'",
|
||||||
|
"img-src 'self' data:",
|
||||||
|
"font-src 'self'",
|
||||||
|
"connect-src 'self'",
|
||||||
|
"frame-ancestors 'none'",
|
||||||
|
"base-uri 'self'",
|
||||||
|
"form-action 'self'",
|
||||||
|
].join("; "),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const nextConfig: NextConfig = {
|
||||||
|
reactStrictMode: true,
|
||||||
|
allowedDevOrigins: ["10.10.150.86"],
|
||||||
|
|
||||||
|
async headers() {
|
||||||
|
return [{ source: "/(.*)", headers: securityHeaders }];
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export default nextConfig;
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../acorn/bin/acorn
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../baseline-browser-mapping/dist/cli.cjs
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../browserslist/cli.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../eslint/bin/eslint.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../eslint-config-prettier/bin/cli.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../js-yaml/bin/js-yaml.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../jsesc/bin/jsesc
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../json5/lib/cli.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../loose-envify/cli.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../nanoid/bin/nanoid.cjs
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../napi-postinstall/lib/cli.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../next/dist/bin/next
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../which/bin/node-which
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../@babel/parser/bin/babel-parser.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../prettier/bin/prettier.cjs
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../resolve/bin/resolve
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../semver/bin/semver.js
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../typescript/bin/tsc
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../typescript/bin/tsserver
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
../update-browserslist-db/cli.js
|
||||||
+21
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2021-present Toyobayashi
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
+1
@@ -0,0 +1 @@
|
|||||||
|
See [https://github.com/toyobayashi/emnapi](https://github.com/toyobayashi/emnapi)
|
||||||
+1354
File diff suppressed because it is too large
Load Diff
+665
@@ -0,0 +1,665 @@
|
|||||||
|
export declare type Ptr = number | bigint
|
||||||
|
|
||||||
|
export declare interface IBuffer extends Uint8Array {}
|
||||||
|
export declare interface BufferCtor {
|
||||||
|
readonly prototype: IBuffer
|
||||||
|
/** @deprecated */
|
||||||
|
new (...args: any[]): IBuffer
|
||||||
|
from: {
|
||||||
|
(buffer: ArrayBufferLike): IBuffer
|
||||||
|
(buffer: ArrayBufferLike, byteOffset: number, length: number): IBuffer
|
||||||
|
}
|
||||||
|
alloc: (size: number) => IBuffer
|
||||||
|
isBuffer: (obj: unknown) => obj is IBuffer
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum GlobalHandle {
|
||||||
|
UNDEFINED = 1,
|
||||||
|
NULL,
|
||||||
|
FALSE,
|
||||||
|
TRUE,
|
||||||
|
GLOBAL
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum Version {
|
||||||
|
NODE_API_SUPPORTED_VERSION_MIN = 1,
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION = 8,
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX = 10,
|
||||||
|
NAPI_VERSION_EXPERIMENTAL = 2147483647 // INT_MAX
|
||||||
|
}
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
|
export declare type Pointer<T> = number
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
|
export declare type PointerPointer<T> = number
|
||||||
|
export declare type FunctionPointer<T extends (...args: any[]) => any> = Pointer<T>
|
||||||
|
export declare type Const<T> = T
|
||||||
|
|
||||||
|
export declare type void_p = Pointer<void>
|
||||||
|
export declare type void_pp = Pointer<void_p>
|
||||||
|
export declare type bool = number
|
||||||
|
export declare type char = number
|
||||||
|
export declare type char_p = Pointer<char>
|
||||||
|
export declare type unsigned_char = number
|
||||||
|
export declare type const_char = Const<char>
|
||||||
|
export declare type const_char_p = Pointer<const_char>
|
||||||
|
export declare type char16_t_p = number
|
||||||
|
export declare type const_char16_t_p = number
|
||||||
|
|
||||||
|
export declare type short = number
|
||||||
|
export declare type unsigned_short = number
|
||||||
|
export declare type int = number
|
||||||
|
export declare type unsigned_int = number
|
||||||
|
export declare type long = number
|
||||||
|
export declare type unsigned_long = number
|
||||||
|
export declare type long_long = bigint
|
||||||
|
export declare type unsigned_long_long = bigint
|
||||||
|
export declare type float = number
|
||||||
|
export declare type double = number
|
||||||
|
export declare type long_double = number
|
||||||
|
export declare type size_t = number
|
||||||
|
|
||||||
|
export declare type int8_t = number
|
||||||
|
export declare type uint8_t = number
|
||||||
|
export declare type int16_t = number
|
||||||
|
export declare type uint16_t = number
|
||||||
|
export declare type int32_t = number
|
||||||
|
export declare type uint32_t = number
|
||||||
|
export declare type int64_t = bigint
|
||||||
|
export declare type uint64_t = bigint
|
||||||
|
export declare type napi_env = Pointer<unknown>
|
||||||
|
|
||||||
|
export declare type napi_value = Pointer<unknown>
|
||||||
|
export declare type napi_ref = Pointer<unknown>
|
||||||
|
export declare type napi_deferred = Pointer<unknown>
|
||||||
|
export declare type napi_handle_scope = Pointer<unknown>
|
||||||
|
export declare type napi_escapable_handle_scope = Pointer<unknown>
|
||||||
|
|
||||||
|
export declare type napi_addon_register_func = FunctionPointer<(env: napi_env, exports: napi_value) => napi_value>
|
||||||
|
|
||||||
|
export declare type napi_callback_info = Pointer<unknown>
|
||||||
|
export declare type napi_callback = FunctionPointer<(env: napi_env, info: napi_callback_info) => napi_value>
|
||||||
|
|
||||||
|
export declare interface napi_extended_error_info {
|
||||||
|
error_message: const_char_p
|
||||||
|
engine_reserved: void_p
|
||||||
|
engine_error_code: uint32_t
|
||||||
|
error_code: napi_status
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface napi_property_descriptor {
|
||||||
|
// One of utf8name or name should be NULL.
|
||||||
|
utf8name: const_char_p
|
||||||
|
name: napi_value
|
||||||
|
|
||||||
|
method: napi_callback
|
||||||
|
getter: napi_callback
|
||||||
|
setter: napi_callback
|
||||||
|
value: napi_value
|
||||||
|
/* napi_property_attributes */
|
||||||
|
attributes: number
|
||||||
|
data: void_p
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare type napi_finalize = FunctionPointer<(
|
||||||
|
env: napi_env,
|
||||||
|
finalize_data: void_p,
|
||||||
|
finalize_hint: void_p
|
||||||
|
) => void>
|
||||||
|
|
||||||
|
export declare interface node_module {
|
||||||
|
nm_version: int32_t
|
||||||
|
nm_flags: uint32_t
|
||||||
|
nm_filename: Pointer<const_char>
|
||||||
|
nm_register_func: napi_addon_register_func
|
||||||
|
nm_modname: Pointer<const_char>
|
||||||
|
nm_priv: Pointer<void>
|
||||||
|
reserved: PointerPointer<void>
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface napi_node_version {
|
||||||
|
major: uint32_t
|
||||||
|
minor: uint32_t
|
||||||
|
patch: uint32_t
|
||||||
|
release: const_char_p
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface emnapi_emscripten_version {
|
||||||
|
major: uint32_t
|
||||||
|
minor: uint32_t
|
||||||
|
patch: uint32_t
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_status {
|
||||||
|
napi_ok,
|
||||||
|
napi_invalid_arg,
|
||||||
|
napi_object_expected,
|
||||||
|
napi_string_expected,
|
||||||
|
napi_name_expected,
|
||||||
|
napi_function_expected,
|
||||||
|
napi_number_expected,
|
||||||
|
napi_boolean_expected,
|
||||||
|
napi_array_expected,
|
||||||
|
napi_generic_failure,
|
||||||
|
napi_pending_exception,
|
||||||
|
napi_cancelled,
|
||||||
|
napi_escape_called_twice,
|
||||||
|
napi_handle_scope_mismatch,
|
||||||
|
napi_callback_scope_mismatch,
|
||||||
|
napi_queue_full,
|
||||||
|
napi_closing,
|
||||||
|
napi_bigint_expected,
|
||||||
|
napi_date_expected,
|
||||||
|
napi_arraybuffer_expected,
|
||||||
|
napi_detachable_arraybuffer_expected,
|
||||||
|
napi_would_deadlock, // unused
|
||||||
|
napi_no_external_buffers_allowed,
|
||||||
|
napi_cannot_run_js
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_property_attributes {
|
||||||
|
napi_default = 0,
|
||||||
|
napi_writable = 1 << 0,
|
||||||
|
napi_enumerable = 1 << 1,
|
||||||
|
napi_configurable = 1 << 2,
|
||||||
|
|
||||||
|
// Used with napi_define_class to distinguish static properties
|
||||||
|
// from instance properties. Ignored by napi_define_properties.
|
||||||
|
napi_static = 1 << 10,
|
||||||
|
|
||||||
|
/// #ifdef NAPI_EXPERIMENTAL
|
||||||
|
// Default for class methods.
|
||||||
|
napi_default_method = napi_writable | napi_configurable,
|
||||||
|
|
||||||
|
// Default for object properties, like in JS obj[prop].
|
||||||
|
napi_default_jsproperty = napi_writable | napi_enumerable | napi_configurable
|
||||||
|
/// #endif // NAPI_EXPERIMENTAL
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_valuetype {
|
||||||
|
napi_undefined,
|
||||||
|
napi_null,
|
||||||
|
napi_boolean,
|
||||||
|
napi_number,
|
||||||
|
napi_string,
|
||||||
|
napi_symbol,
|
||||||
|
napi_object,
|
||||||
|
napi_function,
|
||||||
|
napi_external,
|
||||||
|
napi_bigint
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_typedarray_type {
|
||||||
|
napi_int8_array,
|
||||||
|
napi_uint8_array,
|
||||||
|
napi_uint8_clamped_array,
|
||||||
|
napi_int16_array,
|
||||||
|
napi_uint16_array,
|
||||||
|
napi_int32_array,
|
||||||
|
napi_uint32_array,
|
||||||
|
napi_float32_array,
|
||||||
|
napi_float64_array,
|
||||||
|
napi_bigint64_array,
|
||||||
|
napi_biguint64_array,
|
||||||
|
napi_float16_array,
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_collection_mode {
|
||||||
|
napi_key_include_prototypes,
|
||||||
|
napi_key_own_only
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_filter {
|
||||||
|
napi_key_all_properties = 0,
|
||||||
|
napi_key_writable = 1,
|
||||||
|
napi_key_enumerable = 1 << 1,
|
||||||
|
napi_key_configurable = 1 << 2,
|
||||||
|
napi_key_skip_strings = 1 << 3,
|
||||||
|
napi_key_skip_symbols = 1 << 4
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_conversion {
|
||||||
|
napi_key_keep_numbers,
|
||||||
|
napi_key_numbers_to_strings
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum emnapi_memory_view_type {
|
||||||
|
emnapi_int8_array,
|
||||||
|
emnapi_uint8_array,
|
||||||
|
emnapi_uint8_clamped_array,
|
||||||
|
emnapi_int16_array,
|
||||||
|
emnapi_uint16_array,
|
||||||
|
emnapi_int32_array,
|
||||||
|
emnapi_uint32_array,
|
||||||
|
emnapi_float32_array,
|
||||||
|
emnapi_float64_array,
|
||||||
|
emnapi_bigint64_array,
|
||||||
|
emnapi_biguint64_array,
|
||||||
|
emnapi_float16_array,
|
||||||
|
emnapi_data_view = -1,
|
||||||
|
emnapi_buffer = -2
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_threadsafe_function_call_mode {
|
||||||
|
napi_tsfn_nonblocking,
|
||||||
|
napi_tsfn_blocking
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_threadsafe_function_release_mode {
|
||||||
|
napi_tsfn_release,
|
||||||
|
napi_tsfn_abort
|
||||||
|
}
|
||||||
|
export declare type CleanupHookCallbackFunction = number | ((arg: number) => void);
|
||||||
|
|
||||||
|
export declare class ConstHandle<S extends undefined | null | boolean | typeof globalThis> extends Handle<S> {
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Context {
|
||||||
|
private _isStopping;
|
||||||
|
private _canCallIntoJs;
|
||||||
|
private _suppressDestroy;
|
||||||
|
envStore: Store<Env>;
|
||||||
|
scopeStore: ScopeStore;
|
||||||
|
refStore: Store<Reference>;
|
||||||
|
deferredStore: Store<Deferred<any>>;
|
||||||
|
handleStore: HandleStore;
|
||||||
|
private readonly refCounter?;
|
||||||
|
private readonly cleanupQueue;
|
||||||
|
feature: {
|
||||||
|
supportReflect: boolean;
|
||||||
|
supportFinalizer: boolean;
|
||||||
|
supportWeakSymbol: boolean;
|
||||||
|
supportBigInt: boolean;
|
||||||
|
supportNewFunction: boolean;
|
||||||
|
canSetFunctionName: boolean;
|
||||||
|
setImmediate: (callback: () => void) => void;
|
||||||
|
Buffer: BufferCtor | undefined;
|
||||||
|
MessageChannel: {
|
||||||
|
new (): MessageChannel;
|
||||||
|
prototype: MessageChannel;
|
||||||
|
} | undefined;
|
||||||
|
};
|
||||||
|
constructor();
|
||||||
|
/**
|
||||||
|
* Suppress the destroy on `beforeExit` event in Node.js.
|
||||||
|
* Call this method if you want to keep the context and
|
||||||
|
* all associated {@link Env | Env} alive,
|
||||||
|
* this also means that cleanup hooks will not be called.
|
||||||
|
* After call this method, you should call
|
||||||
|
* {@link Context.destroy | `Context.prototype.destroy`} method manually.
|
||||||
|
*/
|
||||||
|
suppressDestroy(): void;
|
||||||
|
getRuntimeVersions(): {
|
||||||
|
version: string;
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX: Version;
|
||||||
|
NAPI_VERSION_EXPERIMENTAL: Version;
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION: Version;
|
||||||
|
};
|
||||||
|
createNotSupportWeakRefError(api: string, message: string): NotSupportWeakRefError;
|
||||||
|
createNotSupportBufferError(api: string, message: string): NotSupportBufferError;
|
||||||
|
createReference(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership): Reference;
|
||||||
|
createReferenceWithData(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): Reference;
|
||||||
|
createReferenceWithFinalizer(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback?: napi_finalize, finalize_data?: void_p, finalize_hint?: void_p): Reference;
|
||||||
|
createDeferred<T = any>(value: IDeferrdValue<T>): Deferred<T>;
|
||||||
|
createEnv(filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any): Env;
|
||||||
|
createTrackedFinalizer(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
getCurrentScope(): HandleScope | null;
|
||||||
|
addToCurrentScope<V>(value: V): Handle<V>;
|
||||||
|
openScope(envObject?: Env): HandleScope;
|
||||||
|
closeScope(envObject?: Env, _scope?: HandleScope): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
addCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
removeCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
runCleanup(): void;
|
||||||
|
increaseWaitingRequestCounter(): void;
|
||||||
|
decreaseWaitingRequestCounter(): void;
|
||||||
|
setCanCallIntoJs(value: boolean): void;
|
||||||
|
setStopping(value: boolean): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
/**
|
||||||
|
* Destroy the context and call cleanup hooks.
|
||||||
|
* Associated {@link Env | Env} will be destroyed.
|
||||||
|
*/
|
||||||
|
destroy(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare function createContext(): Context;
|
||||||
|
|
||||||
|
export declare class Deferred<T = any> implements IStoreValue {
|
||||||
|
static create<T = any>(ctx: Context, value: IDeferrdValue<T>): Deferred;
|
||||||
|
id: number;
|
||||||
|
ctx: Context;
|
||||||
|
value: IDeferrdValue<T>;
|
||||||
|
constructor(ctx: Context, value: IDeferrdValue<T>);
|
||||||
|
resolve(value: T): void;
|
||||||
|
reject(reason?: any): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class EmnapiError extends Error {
|
||||||
|
constructor(message?: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare abstract class Env implements IStoreValue {
|
||||||
|
readonly ctx: Context;
|
||||||
|
moduleApiVersion: number;
|
||||||
|
makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void;
|
||||||
|
makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void;
|
||||||
|
abort: (msg?: string) => never;
|
||||||
|
id: number;
|
||||||
|
openHandleScopes: number;
|
||||||
|
instanceData: TrackedFinalizer | null;
|
||||||
|
tryCatch: TryCatch;
|
||||||
|
refs: number;
|
||||||
|
reflist: RefTracker;
|
||||||
|
finalizing_reflist: RefTracker;
|
||||||
|
pendingFinalizers: RefTracker[];
|
||||||
|
lastError: {
|
||||||
|
errorCode: napi_status;
|
||||||
|
engineErrorCode: number;
|
||||||
|
engineReserved: Ptr;
|
||||||
|
};
|
||||||
|
inGcFinalizer: boolean;
|
||||||
|
constructor(ctx: Context, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never);
|
||||||
|
/** @virtual */
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
terminatedOrTerminating(): boolean;
|
||||||
|
ref(): void;
|
||||||
|
unref(): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
ensureHandleId(value: any): napi_value;
|
||||||
|
clearLastError(): napi_status;
|
||||||
|
setLastError(error_code: napi_status, engine_error_code?: uint32_t, engine_reserved?: void_p): napi_status;
|
||||||
|
getReturnStatus(): napi_status;
|
||||||
|
callIntoModule<T>(fn: (env: Env) => T, handleException?: (envObject: Env, value: any) => void): T;
|
||||||
|
/** @virtual */
|
||||||
|
abstract callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
invokeFinalizerFromGC(finalizer: RefTracker): void;
|
||||||
|
checkGCAccess(): void;
|
||||||
|
/** @virtual */
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
dequeueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
deleteMe(): void;
|
||||||
|
dispose(): void;
|
||||||
|
private readonly _bindingMap;
|
||||||
|
initObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
getObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
setInstanceData(data: number, finalize_cb: number, finalize_hint: number): void;
|
||||||
|
getInstanceData(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
declare interface External_2 extends Record<any, any> {
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
declare const External_2: {
|
||||||
|
new (value: number | bigint): External_2;
|
||||||
|
prototype: null;
|
||||||
|
};
|
||||||
|
export { External_2 as External }
|
||||||
|
|
||||||
|
export declare class Finalizer {
|
||||||
|
envObject: Env;
|
||||||
|
private _finalizeCallback;
|
||||||
|
private _finalizeData;
|
||||||
|
private _finalizeHint;
|
||||||
|
private _makeDynCall_vppp;
|
||||||
|
constructor(envObject: Env, _finalizeCallback?: napi_finalize, _finalizeData?: void_p, _finalizeHint?: void_p);
|
||||||
|
callback(): napi_finalize;
|
||||||
|
data(): void_p;
|
||||||
|
hint(): void_p;
|
||||||
|
resetEnv(): void;
|
||||||
|
resetFinalizer(): void;
|
||||||
|
callFinalizer(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare function getDefaultContext(): Context;
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare function getExternalValue(external: External_2): number | bigint;
|
||||||
|
|
||||||
|
export declare class Handle<S> {
|
||||||
|
id: number;
|
||||||
|
value: S;
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
data(): void_p;
|
||||||
|
isNumber(): boolean;
|
||||||
|
isBigInt(): boolean;
|
||||||
|
isString(): boolean;
|
||||||
|
isFunction(): boolean;
|
||||||
|
isExternal(): boolean;
|
||||||
|
isObject(): boolean;
|
||||||
|
isArray(): boolean;
|
||||||
|
isArrayBuffer(): boolean;
|
||||||
|
isTypedArray(): boolean;
|
||||||
|
isBuffer(BufferConstructor?: BufferCtor): boolean;
|
||||||
|
isDataView(): boolean;
|
||||||
|
isDate(): boolean;
|
||||||
|
isPromise(): boolean;
|
||||||
|
isBoolean(): boolean;
|
||||||
|
isUndefined(): boolean;
|
||||||
|
isSymbol(): boolean;
|
||||||
|
isNull(): boolean;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class HandleScope {
|
||||||
|
handleStore: HandleStore;
|
||||||
|
id: number;
|
||||||
|
parent: HandleScope | null;
|
||||||
|
child: HandleScope | null;
|
||||||
|
start: number;
|
||||||
|
end: number;
|
||||||
|
private _escapeCalled;
|
||||||
|
callbackInfo: ICallbackInfo;
|
||||||
|
constructor(handleStore: HandleStore, id: number, parentScope: HandleScope | null, start: number, end?: number);
|
||||||
|
add<V>(value: V): Handle<V>;
|
||||||
|
addExternal(data: void_p): Handle<object>;
|
||||||
|
dispose(): void;
|
||||||
|
escape(handle: number): Handle<any> | null;
|
||||||
|
escapeCalled(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class HandleStore {
|
||||||
|
static UNDEFINED: ConstHandle<undefined>;
|
||||||
|
static NULL: ConstHandle<null>;
|
||||||
|
static FALSE: ConstHandle<false>;
|
||||||
|
static TRUE: ConstHandle<true>;
|
||||||
|
static GLOBAL: ConstHandle<typeof globalThis>;
|
||||||
|
static MIN_ID: 6;
|
||||||
|
private readonly _values;
|
||||||
|
private _next;
|
||||||
|
push<S>(value: S): Handle<S>;
|
||||||
|
erase(start: number, end: number): void;
|
||||||
|
get(id: Ptr): Handle<any> | undefined;
|
||||||
|
swap(a: number, b: number): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface ICallbackInfo {
|
||||||
|
thiz: any;
|
||||||
|
data: void_p;
|
||||||
|
args: ArrayLike<any>;
|
||||||
|
fn: Function;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface IDeferrdValue<T = any> {
|
||||||
|
resolve: (value: T) => void;
|
||||||
|
reject: (reason?: any) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface IReferenceBinding {
|
||||||
|
wrapped: number;
|
||||||
|
tag: Uint32Array | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare function isExternal(object: unknown): object is External_2;
|
||||||
|
|
||||||
|
export declare function isReferenceType(v: any): v is object;
|
||||||
|
|
||||||
|
export declare interface IStoreValue {
|
||||||
|
id: number;
|
||||||
|
dispose(): void;
|
||||||
|
[x: string]: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const NAPI_VERSION_EXPERIMENTAL = Version.NAPI_VERSION_EXPERIMENTAL;
|
||||||
|
|
||||||
|
export declare const NODE_API_DEFAULT_MODULE_API_VERSION = Version.NODE_API_DEFAULT_MODULE_API_VERSION;
|
||||||
|
|
||||||
|
export declare const NODE_API_SUPPORTED_VERSION_MAX = Version.NODE_API_SUPPORTED_VERSION_MAX;
|
||||||
|
|
||||||
|
export declare const NODE_API_SUPPORTED_VERSION_MIN = Version.NODE_API_SUPPORTED_VERSION_MIN;
|
||||||
|
|
||||||
|
export declare class NodeEnv extends Env {
|
||||||
|
filename: string;
|
||||||
|
private readonly nodeBinding?;
|
||||||
|
destructing: boolean;
|
||||||
|
finalizationScheduled: boolean;
|
||||||
|
constructor(ctx: Context, filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any);
|
||||||
|
deleteMe(): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
triggerFatalException(err: any): void;
|
||||||
|
callbackIntoModule<T>(enforceUncaughtExceptionPolicy: boolean, fn: (env: Env) => T): T;
|
||||||
|
callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
callFinalizerInternal(forceUncaught: int, cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
drainFinalizerQueue(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class NotSupportBufferError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class NotSupportWeakRefError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Persistent<T> {
|
||||||
|
private _ref;
|
||||||
|
private _param;
|
||||||
|
private _callback;
|
||||||
|
private static readonly _registry;
|
||||||
|
constructor(value: T);
|
||||||
|
setWeak<P>(param: P, callback: (param: P) => void): void;
|
||||||
|
clearWeak(): void;
|
||||||
|
reset(): void;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
deref(): T | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Reference extends RefTracker implements IStoreValue {
|
||||||
|
private static weakCallback;
|
||||||
|
id: number;
|
||||||
|
envObject: Env;
|
||||||
|
private readonly canBeWeak;
|
||||||
|
private _refcount;
|
||||||
|
private readonly _ownership;
|
||||||
|
persistent: Persistent<object>;
|
||||||
|
static create(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, _unused1?: void_p, _unused2?: void_p, _unused3?: void_p): Reference;
|
||||||
|
protected constructor(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership);
|
||||||
|
ref(): number;
|
||||||
|
unref(): number;
|
||||||
|
get(envObject?: Env): napi_value;
|
||||||
|
/** @virtual */
|
||||||
|
resetFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
data(): void_p;
|
||||||
|
refcount(): number;
|
||||||
|
ownership(): ReferenceOwnership;
|
||||||
|
/** @virtual */
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
private _setWeak;
|
||||||
|
finalize(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare enum ReferenceOwnership {
|
||||||
|
kRuntime = 0,
|
||||||
|
kUserland = 1
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ReferenceWithData extends Reference {
|
||||||
|
private readonly _data;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): ReferenceWithData;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ReferenceWithFinalizer extends Reference {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): ReferenceWithFinalizer;
|
||||||
|
private constructor();
|
||||||
|
resetFinalizer(): void;
|
||||||
|
data(): void_p;
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class RefTracker {
|
||||||
|
/** @virtual */
|
||||||
|
dispose(): void;
|
||||||
|
/** @virtual */
|
||||||
|
finalize(): void;
|
||||||
|
private _next;
|
||||||
|
private _prev;
|
||||||
|
link(list: RefTracker): void;
|
||||||
|
unlink(): void;
|
||||||
|
static finalizeAll(list: RefTracker): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ScopeStore {
|
||||||
|
private readonly _rootScope;
|
||||||
|
currentScope: HandleScope;
|
||||||
|
private readonly _values;
|
||||||
|
constructor();
|
||||||
|
get(id: number): HandleScope | undefined;
|
||||||
|
openScope(handleStore: HandleStore): HandleScope;
|
||||||
|
closeScope(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Store<V extends IStoreValue> {
|
||||||
|
protected _values: Array<V | undefined>;
|
||||||
|
private _freeList;
|
||||||
|
private _size;
|
||||||
|
constructor();
|
||||||
|
add(value: V): void;
|
||||||
|
get(id: Ptr): V | undefined;
|
||||||
|
has(id: Ptr): boolean;
|
||||||
|
remove(id: Ptr): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class TrackedFinalizer extends RefTracker {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
dispose(): void;
|
||||||
|
finalize(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class TryCatch {
|
||||||
|
private _exception;
|
||||||
|
private _caught;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
hasCaught(): boolean;
|
||||||
|
exception(): any;
|
||||||
|
setError(err: any): void;
|
||||||
|
reset(): void;
|
||||||
|
extractException(): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const version: string;
|
||||||
|
|
||||||
|
export { }
|
||||||
+1
File diff suppressed because one or more lines are too long
+665
@@ -0,0 +1,665 @@
|
|||||||
|
export declare type Ptr = number | bigint
|
||||||
|
|
||||||
|
export declare interface IBuffer extends Uint8Array {}
|
||||||
|
export declare interface BufferCtor {
|
||||||
|
readonly prototype: IBuffer
|
||||||
|
/** @deprecated */
|
||||||
|
new (...args: any[]): IBuffer
|
||||||
|
from: {
|
||||||
|
(buffer: ArrayBufferLike): IBuffer
|
||||||
|
(buffer: ArrayBufferLike, byteOffset: number, length: number): IBuffer
|
||||||
|
}
|
||||||
|
alloc: (size: number) => IBuffer
|
||||||
|
isBuffer: (obj: unknown) => obj is IBuffer
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum GlobalHandle {
|
||||||
|
UNDEFINED = 1,
|
||||||
|
NULL,
|
||||||
|
FALSE,
|
||||||
|
TRUE,
|
||||||
|
GLOBAL
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum Version {
|
||||||
|
NODE_API_SUPPORTED_VERSION_MIN = 1,
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION = 8,
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX = 10,
|
||||||
|
NAPI_VERSION_EXPERIMENTAL = 2147483647 // INT_MAX
|
||||||
|
}
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
|
export declare type Pointer<T> = number
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
|
export declare type PointerPointer<T> = number
|
||||||
|
export declare type FunctionPointer<T extends (...args: any[]) => any> = Pointer<T>
|
||||||
|
export declare type Const<T> = T
|
||||||
|
|
||||||
|
export declare type void_p = Pointer<void>
|
||||||
|
export declare type void_pp = Pointer<void_p>
|
||||||
|
export declare type bool = number
|
||||||
|
export declare type char = number
|
||||||
|
export declare type char_p = Pointer<char>
|
||||||
|
export declare type unsigned_char = number
|
||||||
|
export declare type const_char = Const<char>
|
||||||
|
export declare type const_char_p = Pointer<const_char>
|
||||||
|
export declare type char16_t_p = number
|
||||||
|
export declare type const_char16_t_p = number
|
||||||
|
|
||||||
|
export declare type short = number
|
||||||
|
export declare type unsigned_short = number
|
||||||
|
export declare type int = number
|
||||||
|
export declare type unsigned_int = number
|
||||||
|
export declare type long = number
|
||||||
|
export declare type unsigned_long = number
|
||||||
|
export declare type long_long = bigint
|
||||||
|
export declare type unsigned_long_long = bigint
|
||||||
|
export declare type float = number
|
||||||
|
export declare type double = number
|
||||||
|
export declare type long_double = number
|
||||||
|
export declare type size_t = number
|
||||||
|
|
||||||
|
export declare type int8_t = number
|
||||||
|
export declare type uint8_t = number
|
||||||
|
export declare type int16_t = number
|
||||||
|
export declare type uint16_t = number
|
||||||
|
export declare type int32_t = number
|
||||||
|
export declare type uint32_t = number
|
||||||
|
export declare type int64_t = bigint
|
||||||
|
export declare type uint64_t = bigint
|
||||||
|
export declare type napi_env = Pointer<unknown>
|
||||||
|
|
||||||
|
export declare type napi_value = Pointer<unknown>
|
||||||
|
export declare type napi_ref = Pointer<unknown>
|
||||||
|
export declare type napi_deferred = Pointer<unknown>
|
||||||
|
export declare type napi_handle_scope = Pointer<unknown>
|
||||||
|
export declare type napi_escapable_handle_scope = Pointer<unknown>
|
||||||
|
|
||||||
|
export declare type napi_addon_register_func = FunctionPointer<(env: napi_env, exports: napi_value) => napi_value>
|
||||||
|
|
||||||
|
export declare type napi_callback_info = Pointer<unknown>
|
||||||
|
export declare type napi_callback = FunctionPointer<(env: napi_env, info: napi_callback_info) => napi_value>
|
||||||
|
|
||||||
|
export declare interface napi_extended_error_info {
|
||||||
|
error_message: const_char_p
|
||||||
|
engine_reserved: void_p
|
||||||
|
engine_error_code: uint32_t
|
||||||
|
error_code: napi_status
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface napi_property_descriptor {
|
||||||
|
// One of utf8name or name should be NULL.
|
||||||
|
utf8name: const_char_p
|
||||||
|
name: napi_value
|
||||||
|
|
||||||
|
method: napi_callback
|
||||||
|
getter: napi_callback
|
||||||
|
setter: napi_callback
|
||||||
|
value: napi_value
|
||||||
|
/* napi_property_attributes */
|
||||||
|
attributes: number
|
||||||
|
data: void_p
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare type napi_finalize = FunctionPointer<(
|
||||||
|
env: napi_env,
|
||||||
|
finalize_data: void_p,
|
||||||
|
finalize_hint: void_p
|
||||||
|
) => void>
|
||||||
|
|
||||||
|
export declare interface node_module {
|
||||||
|
nm_version: int32_t
|
||||||
|
nm_flags: uint32_t
|
||||||
|
nm_filename: Pointer<const_char>
|
||||||
|
nm_register_func: napi_addon_register_func
|
||||||
|
nm_modname: Pointer<const_char>
|
||||||
|
nm_priv: Pointer<void>
|
||||||
|
reserved: PointerPointer<void>
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface napi_node_version {
|
||||||
|
major: uint32_t
|
||||||
|
minor: uint32_t
|
||||||
|
patch: uint32_t
|
||||||
|
release: const_char_p
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface emnapi_emscripten_version {
|
||||||
|
major: uint32_t
|
||||||
|
minor: uint32_t
|
||||||
|
patch: uint32_t
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_status {
|
||||||
|
napi_ok,
|
||||||
|
napi_invalid_arg,
|
||||||
|
napi_object_expected,
|
||||||
|
napi_string_expected,
|
||||||
|
napi_name_expected,
|
||||||
|
napi_function_expected,
|
||||||
|
napi_number_expected,
|
||||||
|
napi_boolean_expected,
|
||||||
|
napi_array_expected,
|
||||||
|
napi_generic_failure,
|
||||||
|
napi_pending_exception,
|
||||||
|
napi_cancelled,
|
||||||
|
napi_escape_called_twice,
|
||||||
|
napi_handle_scope_mismatch,
|
||||||
|
napi_callback_scope_mismatch,
|
||||||
|
napi_queue_full,
|
||||||
|
napi_closing,
|
||||||
|
napi_bigint_expected,
|
||||||
|
napi_date_expected,
|
||||||
|
napi_arraybuffer_expected,
|
||||||
|
napi_detachable_arraybuffer_expected,
|
||||||
|
napi_would_deadlock, // unused
|
||||||
|
napi_no_external_buffers_allowed,
|
||||||
|
napi_cannot_run_js
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_property_attributes {
|
||||||
|
napi_default = 0,
|
||||||
|
napi_writable = 1 << 0,
|
||||||
|
napi_enumerable = 1 << 1,
|
||||||
|
napi_configurable = 1 << 2,
|
||||||
|
|
||||||
|
// Used with napi_define_class to distinguish static properties
|
||||||
|
// from instance properties. Ignored by napi_define_properties.
|
||||||
|
napi_static = 1 << 10,
|
||||||
|
|
||||||
|
/// #ifdef NAPI_EXPERIMENTAL
|
||||||
|
// Default for class methods.
|
||||||
|
napi_default_method = napi_writable | napi_configurable,
|
||||||
|
|
||||||
|
// Default for object properties, like in JS obj[prop].
|
||||||
|
napi_default_jsproperty = napi_writable | napi_enumerable | napi_configurable
|
||||||
|
/// #endif // NAPI_EXPERIMENTAL
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_valuetype {
|
||||||
|
napi_undefined,
|
||||||
|
napi_null,
|
||||||
|
napi_boolean,
|
||||||
|
napi_number,
|
||||||
|
napi_string,
|
||||||
|
napi_symbol,
|
||||||
|
napi_object,
|
||||||
|
napi_function,
|
||||||
|
napi_external,
|
||||||
|
napi_bigint
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_typedarray_type {
|
||||||
|
napi_int8_array,
|
||||||
|
napi_uint8_array,
|
||||||
|
napi_uint8_clamped_array,
|
||||||
|
napi_int16_array,
|
||||||
|
napi_uint16_array,
|
||||||
|
napi_int32_array,
|
||||||
|
napi_uint32_array,
|
||||||
|
napi_float32_array,
|
||||||
|
napi_float64_array,
|
||||||
|
napi_bigint64_array,
|
||||||
|
napi_biguint64_array,
|
||||||
|
napi_float16_array,
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_collection_mode {
|
||||||
|
napi_key_include_prototypes,
|
||||||
|
napi_key_own_only
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_filter {
|
||||||
|
napi_key_all_properties = 0,
|
||||||
|
napi_key_writable = 1,
|
||||||
|
napi_key_enumerable = 1 << 1,
|
||||||
|
napi_key_configurable = 1 << 2,
|
||||||
|
napi_key_skip_strings = 1 << 3,
|
||||||
|
napi_key_skip_symbols = 1 << 4
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_conversion {
|
||||||
|
napi_key_keep_numbers,
|
||||||
|
napi_key_numbers_to_strings
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum emnapi_memory_view_type {
|
||||||
|
emnapi_int8_array,
|
||||||
|
emnapi_uint8_array,
|
||||||
|
emnapi_uint8_clamped_array,
|
||||||
|
emnapi_int16_array,
|
||||||
|
emnapi_uint16_array,
|
||||||
|
emnapi_int32_array,
|
||||||
|
emnapi_uint32_array,
|
||||||
|
emnapi_float32_array,
|
||||||
|
emnapi_float64_array,
|
||||||
|
emnapi_bigint64_array,
|
||||||
|
emnapi_biguint64_array,
|
||||||
|
emnapi_float16_array,
|
||||||
|
emnapi_data_view = -1,
|
||||||
|
emnapi_buffer = -2
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_threadsafe_function_call_mode {
|
||||||
|
napi_tsfn_nonblocking,
|
||||||
|
napi_tsfn_blocking
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_threadsafe_function_release_mode {
|
||||||
|
napi_tsfn_release,
|
||||||
|
napi_tsfn_abort
|
||||||
|
}
|
||||||
|
export declare type CleanupHookCallbackFunction = number | ((arg: number) => void);
|
||||||
|
|
||||||
|
export declare class ConstHandle<S extends undefined | null | boolean | typeof globalThis> extends Handle<S> {
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Context {
|
||||||
|
private _isStopping;
|
||||||
|
private _canCallIntoJs;
|
||||||
|
private _suppressDestroy;
|
||||||
|
envStore: Store<Env>;
|
||||||
|
scopeStore: ScopeStore;
|
||||||
|
refStore: Store<Reference>;
|
||||||
|
deferredStore: Store<Deferred<any>>;
|
||||||
|
handleStore: HandleStore;
|
||||||
|
private readonly refCounter?;
|
||||||
|
private readonly cleanupQueue;
|
||||||
|
feature: {
|
||||||
|
supportReflect: boolean;
|
||||||
|
supportFinalizer: boolean;
|
||||||
|
supportWeakSymbol: boolean;
|
||||||
|
supportBigInt: boolean;
|
||||||
|
supportNewFunction: boolean;
|
||||||
|
canSetFunctionName: boolean;
|
||||||
|
setImmediate: (callback: () => void) => void;
|
||||||
|
Buffer: BufferCtor | undefined;
|
||||||
|
MessageChannel: {
|
||||||
|
new (): MessageChannel;
|
||||||
|
prototype: MessageChannel;
|
||||||
|
} | undefined;
|
||||||
|
};
|
||||||
|
constructor();
|
||||||
|
/**
|
||||||
|
* Suppress the destroy on `beforeExit` event in Node.js.
|
||||||
|
* Call this method if you want to keep the context and
|
||||||
|
* all associated {@link Env | Env} alive,
|
||||||
|
* this also means that cleanup hooks will not be called.
|
||||||
|
* After call this method, you should call
|
||||||
|
* {@link Context.destroy | `Context.prototype.destroy`} method manually.
|
||||||
|
*/
|
||||||
|
suppressDestroy(): void;
|
||||||
|
getRuntimeVersions(): {
|
||||||
|
version: string;
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX: Version;
|
||||||
|
NAPI_VERSION_EXPERIMENTAL: Version;
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION: Version;
|
||||||
|
};
|
||||||
|
createNotSupportWeakRefError(api: string, message: string): NotSupportWeakRefError;
|
||||||
|
createNotSupportBufferError(api: string, message: string): NotSupportBufferError;
|
||||||
|
createReference(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership): Reference;
|
||||||
|
createReferenceWithData(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): Reference;
|
||||||
|
createReferenceWithFinalizer(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback?: napi_finalize, finalize_data?: void_p, finalize_hint?: void_p): Reference;
|
||||||
|
createDeferred<T = any>(value: IDeferrdValue<T>): Deferred<T>;
|
||||||
|
createEnv(filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any): Env;
|
||||||
|
createTrackedFinalizer(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
getCurrentScope(): HandleScope | null;
|
||||||
|
addToCurrentScope<V>(value: V): Handle<V>;
|
||||||
|
openScope(envObject?: Env): HandleScope;
|
||||||
|
closeScope(envObject?: Env, _scope?: HandleScope): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
addCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
removeCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
runCleanup(): void;
|
||||||
|
increaseWaitingRequestCounter(): void;
|
||||||
|
decreaseWaitingRequestCounter(): void;
|
||||||
|
setCanCallIntoJs(value: boolean): void;
|
||||||
|
setStopping(value: boolean): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
/**
|
||||||
|
* Destroy the context and call cleanup hooks.
|
||||||
|
* Associated {@link Env | Env} will be destroyed.
|
||||||
|
*/
|
||||||
|
destroy(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare function createContext(): Context;
|
||||||
|
|
||||||
|
export declare class Deferred<T = any> implements IStoreValue {
|
||||||
|
static create<T = any>(ctx: Context, value: IDeferrdValue<T>): Deferred;
|
||||||
|
id: number;
|
||||||
|
ctx: Context;
|
||||||
|
value: IDeferrdValue<T>;
|
||||||
|
constructor(ctx: Context, value: IDeferrdValue<T>);
|
||||||
|
resolve(value: T): void;
|
||||||
|
reject(reason?: any): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class EmnapiError extends Error {
|
||||||
|
constructor(message?: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare abstract class Env implements IStoreValue {
|
||||||
|
readonly ctx: Context;
|
||||||
|
moduleApiVersion: number;
|
||||||
|
makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void;
|
||||||
|
makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void;
|
||||||
|
abort: (msg?: string) => never;
|
||||||
|
id: number;
|
||||||
|
openHandleScopes: number;
|
||||||
|
instanceData: TrackedFinalizer | null;
|
||||||
|
tryCatch: TryCatch;
|
||||||
|
refs: number;
|
||||||
|
reflist: RefTracker;
|
||||||
|
finalizing_reflist: RefTracker;
|
||||||
|
pendingFinalizers: RefTracker[];
|
||||||
|
lastError: {
|
||||||
|
errorCode: napi_status;
|
||||||
|
engineErrorCode: number;
|
||||||
|
engineReserved: Ptr;
|
||||||
|
};
|
||||||
|
inGcFinalizer: boolean;
|
||||||
|
constructor(ctx: Context, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never);
|
||||||
|
/** @virtual */
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
terminatedOrTerminating(): boolean;
|
||||||
|
ref(): void;
|
||||||
|
unref(): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
ensureHandleId(value: any): napi_value;
|
||||||
|
clearLastError(): napi_status;
|
||||||
|
setLastError(error_code: napi_status, engine_error_code?: uint32_t, engine_reserved?: void_p): napi_status;
|
||||||
|
getReturnStatus(): napi_status;
|
||||||
|
callIntoModule<T>(fn: (env: Env) => T, handleException?: (envObject: Env, value: any) => void): T;
|
||||||
|
/** @virtual */
|
||||||
|
abstract callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
invokeFinalizerFromGC(finalizer: RefTracker): void;
|
||||||
|
checkGCAccess(): void;
|
||||||
|
/** @virtual */
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
dequeueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
deleteMe(): void;
|
||||||
|
dispose(): void;
|
||||||
|
private readonly _bindingMap;
|
||||||
|
initObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
getObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
setInstanceData(data: number, finalize_cb: number, finalize_hint: number): void;
|
||||||
|
getInstanceData(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
declare interface External_2 extends Record<any, any> {
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
declare const External_2: {
|
||||||
|
new (value: number | bigint): External_2;
|
||||||
|
prototype: null;
|
||||||
|
};
|
||||||
|
export { External_2 as External }
|
||||||
|
|
||||||
|
export declare class Finalizer {
|
||||||
|
envObject: Env;
|
||||||
|
private _finalizeCallback;
|
||||||
|
private _finalizeData;
|
||||||
|
private _finalizeHint;
|
||||||
|
private _makeDynCall_vppp;
|
||||||
|
constructor(envObject: Env, _finalizeCallback?: napi_finalize, _finalizeData?: void_p, _finalizeHint?: void_p);
|
||||||
|
callback(): napi_finalize;
|
||||||
|
data(): void_p;
|
||||||
|
hint(): void_p;
|
||||||
|
resetEnv(): void;
|
||||||
|
resetFinalizer(): void;
|
||||||
|
callFinalizer(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare function getDefaultContext(): Context;
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare function getExternalValue(external: External_2): number | bigint;
|
||||||
|
|
||||||
|
export declare class Handle<S> {
|
||||||
|
id: number;
|
||||||
|
value: S;
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
data(): void_p;
|
||||||
|
isNumber(): boolean;
|
||||||
|
isBigInt(): boolean;
|
||||||
|
isString(): boolean;
|
||||||
|
isFunction(): boolean;
|
||||||
|
isExternal(): boolean;
|
||||||
|
isObject(): boolean;
|
||||||
|
isArray(): boolean;
|
||||||
|
isArrayBuffer(): boolean;
|
||||||
|
isTypedArray(): boolean;
|
||||||
|
isBuffer(BufferConstructor?: BufferCtor): boolean;
|
||||||
|
isDataView(): boolean;
|
||||||
|
isDate(): boolean;
|
||||||
|
isPromise(): boolean;
|
||||||
|
isBoolean(): boolean;
|
||||||
|
isUndefined(): boolean;
|
||||||
|
isSymbol(): boolean;
|
||||||
|
isNull(): boolean;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class HandleScope {
|
||||||
|
handleStore: HandleStore;
|
||||||
|
id: number;
|
||||||
|
parent: HandleScope | null;
|
||||||
|
child: HandleScope | null;
|
||||||
|
start: number;
|
||||||
|
end: number;
|
||||||
|
private _escapeCalled;
|
||||||
|
callbackInfo: ICallbackInfo;
|
||||||
|
constructor(handleStore: HandleStore, id: number, parentScope: HandleScope | null, start: number, end?: number);
|
||||||
|
add<V>(value: V): Handle<V>;
|
||||||
|
addExternal(data: void_p): Handle<object>;
|
||||||
|
dispose(): void;
|
||||||
|
escape(handle: number): Handle<any> | null;
|
||||||
|
escapeCalled(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class HandleStore {
|
||||||
|
static UNDEFINED: ConstHandle<undefined>;
|
||||||
|
static NULL: ConstHandle<null>;
|
||||||
|
static FALSE: ConstHandle<false>;
|
||||||
|
static TRUE: ConstHandle<true>;
|
||||||
|
static GLOBAL: ConstHandle<typeof globalThis>;
|
||||||
|
static MIN_ID: 6;
|
||||||
|
private readonly _values;
|
||||||
|
private _next;
|
||||||
|
push<S>(value: S): Handle<S>;
|
||||||
|
erase(start: number, end: number): void;
|
||||||
|
get(id: Ptr): Handle<any> | undefined;
|
||||||
|
swap(a: number, b: number): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface ICallbackInfo {
|
||||||
|
thiz: any;
|
||||||
|
data: void_p;
|
||||||
|
args: ArrayLike<any>;
|
||||||
|
fn: Function;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface IDeferrdValue<T = any> {
|
||||||
|
resolve: (value: T) => void;
|
||||||
|
reject: (reason?: any) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface IReferenceBinding {
|
||||||
|
wrapped: number;
|
||||||
|
tag: Uint32Array | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare function isExternal(object: unknown): object is External_2;
|
||||||
|
|
||||||
|
export declare function isReferenceType(v: any): v is object;
|
||||||
|
|
||||||
|
export declare interface IStoreValue {
|
||||||
|
id: number;
|
||||||
|
dispose(): void;
|
||||||
|
[x: string]: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const NAPI_VERSION_EXPERIMENTAL = Version.NAPI_VERSION_EXPERIMENTAL;
|
||||||
|
|
||||||
|
export declare const NODE_API_DEFAULT_MODULE_API_VERSION = Version.NODE_API_DEFAULT_MODULE_API_VERSION;
|
||||||
|
|
||||||
|
export declare const NODE_API_SUPPORTED_VERSION_MAX = Version.NODE_API_SUPPORTED_VERSION_MAX;
|
||||||
|
|
||||||
|
export declare const NODE_API_SUPPORTED_VERSION_MIN = Version.NODE_API_SUPPORTED_VERSION_MIN;
|
||||||
|
|
||||||
|
export declare class NodeEnv extends Env {
|
||||||
|
filename: string;
|
||||||
|
private readonly nodeBinding?;
|
||||||
|
destructing: boolean;
|
||||||
|
finalizationScheduled: boolean;
|
||||||
|
constructor(ctx: Context, filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any);
|
||||||
|
deleteMe(): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
triggerFatalException(err: any): void;
|
||||||
|
callbackIntoModule<T>(enforceUncaughtExceptionPolicy: boolean, fn: (env: Env) => T): T;
|
||||||
|
callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
callFinalizerInternal(forceUncaught: int, cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
drainFinalizerQueue(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class NotSupportBufferError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class NotSupportWeakRefError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Persistent<T> {
|
||||||
|
private _ref;
|
||||||
|
private _param;
|
||||||
|
private _callback;
|
||||||
|
private static readonly _registry;
|
||||||
|
constructor(value: T);
|
||||||
|
setWeak<P>(param: P, callback: (param: P) => void): void;
|
||||||
|
clearWeak(): void;
|
||||||
|
reset(): void;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
deref(): T | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Reference extends RefTracker implements IStoreValue {
|
||||||
|
private static weakCallback;
|
||||||
|
id: number;
|
||||||
|
envObject: Env;
|
||||||
|
private readonly canBeWeak;
|
||||||
|
private _refcount;
|
||||||
|
private readonly _ownership;
|
||||||
|
persistent: Persistent<object>;
|
||||||
|
static create(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, _unused1?: void_p, _unused2?: void_p, _unused3?: void_p): Reference;
|
||||||
|
protected constructor(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership);
|
||||||
|
ref(): number;
|
||||||
|
unref(): number;
|
||||||
|
get(envObject?: Env): napi_value;
|
||||||
|
/** @virtual */
|
||||||
|
resetFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
data(): void_p;
|
||||||
|
refcount(): number;
|
||||||
|
ownership(): ReferenceOwnership;
|
||||||
|
/** @virtual */
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
private _setWeak;
|
||||||
|
finalize(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare enum ReferenceOwnership {
|
||||||
|
kRuntime = 0,
|
||||||
|
kUserland = 1
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ReferenceWithData extends Reference {
|
||||||
|
private readonly _data;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): ReferenceWithData;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ReferenceWithFinalizer extends Reference {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): ReferenceWithFinalizer;
|
||||||
|
private constructor();
|
||||||
|
resetFinalizer(): void;
|
||||||
|
data(): void_p;
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class RefTracker {
|
||||||
|
/** @virtual */
|
||||||
|
dispose(): void;
|
||||||
|
/** @virtual */
|
||||||
|
finalize(): void;
|
||||||
|
private _next;
|
||||||
|
private _prev;
|
||||||
|
link(list: RefTracker): void;
|
||||||
|
unlink(): void;
|
||||||
|
static finalizeAll(list: RefTracker): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ScopeStore {
|
||||||
|
private readonly _rootScope;
|
||||||
|
currentScope: HandleScope;
|
||||||
|
private readonly _values;
|
||||||
|
constructor();
|
||||||
|
get(id: number): HandleScope | undefined;
|
||||||
|
openScope(handleStore: HandleStore): HandleScope;
|
||||||
|
closeScope(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Store<V extends IStoreValue> {
|
||||||
|
protected _values: Array<V | undefined>;
|
||||||
|
private _freeList;
|
||||||
|
private _size;
|
||||||
|
constructor();
|
||||||
|
add(value: V): void;
|
||||||
|
get(id: Ptr): V | undefined;
|
||||||
|
has(id: Ptr): boolean;
|
||||||
|
remove(id: Ptr): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class TrackedFinalizer extends RefTracker {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
dispose(): void;
|
||||||
|
finalize(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class TryCatch {
|
||||||
|
private _exception;
|
||||||
|
private _caught;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
hasCaught(): boolean;
|
||||||
|
exception(): any;
|
||||||
|
setError(err: any): void;
|
||||||
|
reset(): void;
|
||||||
|
extractException(): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const version: string;
|
||||||
|
|
||||||
|
export { }
|
||||||
+667
@@ -0,0 +1,667 @@
|
|||||||
|
export declare type Ptr = number | bigint
|
||||||
|
|
||||||
|
export declare interface IBuffer extends Uint8Array {}
|
||||||
|
export declare interface BufferCtor {
|
||||||
|
readonly prototype: IBuffer
|
||||||
|
/** @deprecated */
|
||||||
|
new (...args: any[]): IBuffer
|
||||||
|
from: {
|
||||||
|
(buffer: ArrayBufferLike): IBuffer
|
||||||
|
(buffer: ArrayBufferLike, byteOffset: number, length: number): IBuffer
|
||||||
|
}
|
||||||
|
alloc: (size: number) => IBuffer
|
||||||
|
isBuffer: (obj: unknown) => obj is IBuffer
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum GlobalHandle {
|
||||||
|
UNDEFINED = 1,
|
||||||
|
NULL,
|
||||||
|
FALSE,
|
||||||
|
TRUE,
|
||||||
|
GLOBAL
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum Version {
|
||||||
|
NODE_API_SUPPORTED_VERSION_MIN = 1,
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION = 8,
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX = 10,
|
||||||
|
NAPI_VERSION_EXPERIMENTAL = 2147483647 // INT_MAX
|
||||||
|
}
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
|
export declare type Pointer<T> = number
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
|
export declare type PointerPointer<T> = number
|
||||||
|
export declare type FunctionPointer<T extends (...args: any[]) => any> = Pointer<T>
|
||||||
|
export declare type Const<T> = T
|
||||||
|
|
||||||
|
export declare type void_p = Pointer<void>
|
||||||
|
export declare type void_pp = Pointer<void_p>
|
||||||
|
export declare type bool = number
|
||||||
|
export declare type char = number
|
||||||
|
export declare type char_p = Pointer<char>
|
||||||
|
export declare type unsigned_char = number
|
||||||
|
export declare type const_char = Const<char>
|
||||||
|
export declare type const_char_p = Pointer<const_char>
|
||||||
|
export declare type char16_t_p = number
|
||||||
|
export declare type const_char16_t_p = number
|
||||||
|
|
||||||
|
export declare type short = number
|
||||||
|
export declare type unsigned_short = number
|
||||||
|
export declare type int = number
|
||||||
|
export declare type unsigned_int = number
|
||||||
|
export declare type long = number
|
||||||
|
export declare type unsigned_long = number
|
||||||
|
export declare type long_long = bigint
|
||||||
|
export declare type unsigned_long_long = bigint
|
||||||
|
export declare type float = number
|
||||||
|
export declare type double = number
|
||||||
|
export declare type long_double = number
|
||||||
|
export declare type size_t = number
|
||||||
|
|
||||||
|
export declare type int8_t = number
|
||||||
|
export declare type uint8_t = number
|
||||||
|
export declare type int16_t = number
|
||||||
|
export declare type uint16_t = number
|
||||||
|
export declare type int32_t = number
|
||||||
|
export declare type uint32_t = number
|
||||||
|
export declare type int64_t = bigint
|
||||||
|
export declare type uint64_t = bigint
|
||||||
|
export declare type napi_env = Pointer<unknown>
|
||||||
|
|
||||||
|
export declare type napi_value = Pointer<unknown>
|
||||||
|
export declare type napi_ref = Pointer<unknown>
|
||||||
|
export declare type napi_deferred = Pointer<unknown>
|
||||||
|
export declare type napi_handle_scope = Pointer<unknown>
|
||||||
|
export declare type napi_escapable_handle_scope = Pointer<unknown>
|
||||||
|
|
||||||
|
export declare type napi_addon_register_func = FunctionPointer<(env: napi_env, exports: napi_value) => napi_value>
|
||||||
|
|
||||||
|
export declare type napi_callback_info = Pointer<unknown>
|
||||||
|
export declare type napi_callback = FunctionPointer<(env: napi_env, info: napi_callback_info) => napi_value>
|
||||||
|
|
||||||
|
export declare interface napi_extended_error_info {
|
||||||
|
error_message: const_char_p
|
||||||
|
engine_reserved: void_p
|
||||||
|
engine_error_code: uint32_t
|
||||||
|
error_code: napi_status
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface napi_property_descriptor {
|
||||||
|
// One of utf8name or name should be NULL.
|
||||||
|
utf8name: const_char_p
|
||||||
|
name: napi_value
|
||||||
|
|
||||||
|
method: napi_callback
|
||||||
|
getter: napi_callback
|
||||||
|
setter: napi_callback
|
||||||
|
value: napi_value
|
||||||
|
/* napi_property_attributes */
|
||||||
|
attributes: number
|
||||||
|
data: void_p
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare type napi_finalize = FunctionPointer<(
|
||||||
|
env: napi_env,
|
||||||
|
finalize_data: void_p,
|
||||||
|
finalize_hint: void_p
|
||||||
|
) => void>
|
||||||
|
|
||||||
|
export declare interface node_module {
|
||||||
|
nm_version: int32_t
|
||||||
|
nm_flags: uint32_t
|
||||||
|
nm_filename: Pointer<const_char>
|
||||||
|
nm_register_func: napi_addon_register_func
|
||||||
|
nm_modname: Pointer<const_char>
|
||||||
|
nm_priv: Pointer<void>
|
||||||
|
reserved: PointerPointer<void>
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface napi_node_version {
|
||||||
|
major: uint32_t
|
||||||
|
minor: uint32_t
|
||||||
|
patch: uint32_t
|
||||||
|
release: const_char_p
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface emnapi_emscripten_version {
|
||||||
|
major: uint32_t
|
||||||
|
minor: uint32_t
|
||||||
|
patch: uint32_t
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_status {
|
||||||
|
napi_ok,
|
||||||
|
napi_invalid_arg,
|
||||||
|
napi_object_expected,
|
||||||
|
napi_string_expected,
|
||||||
|
napi_name_expected,
|
||||||
|
napi_function_expected,
|
||||||
|
napi_number_expected,
|
||||||
|
napi_boolean_expected,
|
||||||
|
napi_array_expected,
|
||||||
|
napi_generic_failure,
|
||||||
|
napi_pending_exception,
|
||||||
|
napi_cancelled,
|
||||||
|
napi_escape_called_twice,
|
||||||
|
napi_handle_scope_mismatch,
|
||||||
|
napi_callback_scope_mismatch,
|
||||||
|
napi_queue_full,
|
||||||
|
napi_closing,
|
||||||
|
napi_bigint_expected,
|
||||||
|
napi_date_expected,
|
||||||
|
napi_arraybuffer_expected,
|
||||||
|
napi_detachable_arraybuffer_expected,
|
||||||
|
napi_would_deadlock, // unused
|
||||||
|
napi_no_external_buffers_allowed,
|
||||||
|
napi_cannot_run_js
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_property_attributes {
|
||||||
|
napi_default = 0,
|
||||||
|
napi_writable = 1 << 0,
|
||||||
|
napi_enumerable = 1 << 1,
|
||||||
|
napi_configurable = 1 << 2,
|
||||||
|
|
||||||
|
// Used with napi_define_class to distinguish static properties
|
||||||
|
// from instance properties. Ignored by napi_define_properties.
|
||||||
|
napi_static = 1 << 10,
|
||||||
|
|
||||||
|
/// #ifdef NAPI_EXPERIMENTAL
|
||||||
|
// Default for class methods.
|
||||||
|
napi_default_method = napi_writable | napi_configurable,
|
||||||
|
|
||||||
|
// Default for object properties, like in JS obj[prop].
|
||||||
|
napi_default_jsproperty = napi_writable | napi_enumerable | napi_configurable
|
||||||
|
/// #endif // NAPI_EXPERIMENTAL
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_valuetype {
|
||||||
|
napi_undefined,
|
||||||
|
napi_null,
|
||||||
|
napi_boolean,
|
||||||
|
napi_number,
|
||||||
|
napi_string,
|
||||||
|
napi_symbol,
|
||||||
|
napi_object,
|
||||||
|
napi_function,
|
||||||
|
napi_external,
|
||||||
|
napi_bigint
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_typedarray_type {
|
||||||
|
napi_int8_array,
|
||||||
|
napi_uint8_array,
|
||||||
|
napi_uint8_clamped_array,
|
||||||
|
napi_int16_array,
|
||||||
|
napi_uint16_array,
|
||||||
|
napi_int32_array,
|
||||||
|
napi_uint32_array,
|
||||||
|
napi_float32_array,
|
||||||
|
napi_float64_array,
|
||||||
|
napi_bigint64_array,
|
||||||
|
napi_biguint64_array,
|
||||||
|
napi_float16_array,
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_collection_mode {
|
||||||
|
napi_key_include_prototypes,
|
||||||
|
napi_key_own_only
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_filter {
|
||||||
|
napi_key_all_properties = 0,
|
||||||
|
napi_key_writable = 1,
|
||||||
|
napi_key_enumerable = 1 << 1,
|
||||||
|
napi_key_configurable = 1 << 2,
|
||||||
|
napi_key_skip_strings = 1 << 3,
|
||||||
|
napi_key_skip_symbols = 1 << 4
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_conversion {
|
||||||
|
napi_key_keep_numbers,
|
||||||
|
napi_key_numbers_to_strings
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum emnapi_memory_view_type {
|
||||||
|
emnapi_int8_array,
|
||||||
|
emnapi_uint8_array,
|
||||||
|
emnapi_uint8_clamped_array,
|
||||||
|
emnapi_int16_array,
|
||||||
|
emnapi_uint16_array,
|
||||||
|
emnapi_int32_array,
|
||||||
|
emnapi_uint32_array,
|
||||||
|
emnapi_float32_array,
|
||||||
|
emnapi_float64_array,
|
||||||
|
emnapi_bigint64_array,
|
||||||
|
emnapi_biguint64_array,
|
||||||
|
emnapi_float16_array,
|
||||||
|
emnapi_data_view = -1,
|
||||||
|
emnapi_buffer = -2
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_threadsafe_function_call_mode {
|
||||||
|
napi_tsfn_nonblocking,
|
||||||
|
napi_tsfn_blocking
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_threadsafe_function_release_mode {
|
||||||
|
napi_tsfn_release,
|
||||||
|
napi_tsfn_abort
|
||||||
|
}
|
||||||
|
export declare type CleanupHookCallbackFunction = number | ((arg: number) => void);
|
||||||
|
|
||||||
|
export declare class ConstHandle<S extends undefined | null | boolean | typeof globalThis> extends Handle<S> {
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Context {
|
||||||
|
private _isStopping;
|
||||||
|
private _canCallIntoJs;
|
||||||
|
private _suppressDestroy;
|
||||||
|
envStore: Store<Env>;
|
||||||
|
scopeStore: ScopeStore;
|
||||||
|
refStore: Store<Reference>;
|
||||||
|
deferredStore: Store<Deferred<any>>;
|
||||||
|
handleStore: HandleStore;
|
||||||
|
private readonly refCounter?;
|
||||||
|
private readonly cleanupQueue;
|
||||||
|
feature: {
|
||||||
|
supportReflect: boolean;
|
||||||
|
supportFinalizer: boolean;
|
||||||
|
supportWeakSymbol: boolean;
|
||||||
|
supportBigInt: boolean;
|
||||||
|
supportNewFunction: boolean;
|
||||||
|
canSetFunctionName: boolean;
|
||||||
|
setImmediate: (callback: () => void) => void;
|
||||||
|
Buffer: BufferCtor | undefined;
|
||||||
|
MessageChannel: {
|
||||||
|
new (): MessageChannel;
|
||||||
|
prototype: MessageChannel;
|
||||||
|
} | undefined;
|
||||||
|
};
|
||||||
|
constructor();
|
||||||
|
/**
|
||||||
|
* Suppress the destroy on `beforeExit` event in Node.js.
|
||||||
|
* Call this method if you want to keep the context and
|
||||||
|
* all associated {@link Env | Env} alive,
|
||||||
|
* this also means that cleanup hooks will not be called.
|
||||||
|
* After call this method, you should call
|
||||||
|
* {@link Context.destroy | `Context.prototype.destroy`} method manually.
|
||||||
|
*/
|
||||||
|
suppressDestroy(): void;
|
||||||
|
getRuntimeVersions(): {
|
||||||
|
version: string;
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX: Version;
|
||||||
|
NAPI_VERSION_EXPERIMENTAL: Version;
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION: Version;
|
||||||
|
};
|
||||||
|
createNotSupportWeakRefError(api: string, message: string): NotSupportWeakRefError;
|
||||||
|
createNotSupportBufferError(api: string, message: string): NotSupportBufferError;
|
||||||
|
createReference(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership): Reference;
|
||||||
|
createReferenceWithData(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): Reference;
|
||||||
|
createReferenceWithFinalizer(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback?: napi_finalize, finalize_data?: void_p, finalize_hint?: void_p): Reference;
|
||||||
|
createDeferred<T = any>(value: IDeferrdValue<T>): Deferred<T>;
|
||||||
|
createEnv(filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any): Env;
|
||||||
|
createTrackedFinalizer(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
getCurrentScope(): HandleScope | null;
|
||||||
|
addToCurrentScope<V>(value: V): Handle<V>;
|
||||||
|
openScope(envObject?: Env): HandleScope;
|
||||||
|
closeScope(envObject?: Env, _scope?: HandleScope): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
addCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
removeCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
runCleanup(): void;
|
||||||
|
increaseWaitingRequestCounter(): void;
|
||||||
|
decreaseWaitingRequestCounter(): void;
|
||||||
|
setCanCallIntoJs(value: boolean): void;
|
||||||
|
setStopping(value: boolean): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
/**
|
||||||
|
* Destroy the context and call cleanup hooks.
|
||||||
|
* Associated {@link Env | Env} will be destroyed.
|
||||||
|
*/
|
||||||
|
destroy(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare function createContext(): Context;
|
||||||
|
|
||||||
|
export declare class Deferred<T = any> implements IStoreValue {
|
||||||
|
static create<T = any>(ctx: Context, value: IDeferrdValue<T>): Deferred;
|
||||||
|
id: number;
|
||||||
|
ctx: Context;
|
||||||
|
value: IDeferrdValue<T>;
|
||||||
|
constructor(ctx: Context, value: IDeferrdValue<T>);
|
||||||
|
resolve(value: T): void;
|
||||||
|
reject(reason?: any): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class EmnapiError extends Error {
|
||||||
|
constructor(message?: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare abstract class Env implements IStoreValue {
|
||||||
|
readonly ctx: Context;
|
||||||
|
moduleApiVersion: number;
|
||||||
|
makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void;
|
||||||
|
makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void;
|
||||||
|
abort: (msg?: string) => never;
|
||||||
|
id: number;
|
||||||
|
openHandleScopes: number;
|
||||||
|
instanceData: TrackedFinalizer | null;
|
||||||
|
tryCatch: TryCatch;
|
||||||
|
refs: number;
|
||||||
|
reflist: RefTracker;
|
||||||
|
finalizing_reflist: RefTracker;
|
||||||
|
pendingFinalizers: RefTracker[];
|
||||||
|
lastError: {
|
||||||
|
errorCode: napi_status;
|
||||||
|
engineErrorCode: number;
|
||||||
|
engineReserved: Ptr;
|
||||||
|
};
|
||||||
|
inGcFinalizer: boolean;
|
||||||
|
constructor(ctx: Context, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never);
|
||||||
|
/** @virtual */
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
terminatedOrTerminating(): boolean;
|
||||||
|
ref(): void;
|
||||||
|
unref(): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
ensureHandleId(value: any): napi_value;
|
||||||
|
clearLastError(): napi_status;
|
||||||
|
setLastError(error_code: napi_status, engine_error_code?: uint32_t, engine_reserved?: void_p): napi_status;
|
||||||
|
getReturnStatus(): napi_status;
|
||||||
|
callIntoModule<T>(fn: (env: Env) => T, handleException?: (envObject: Env, value: any) => void): T;
|
||||||
|
/** @virtual */
|
||||||
|
abstract callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
invokeFinalizerFromGC(finalizer: RefTracker): void;
|
||||||
|
checkGCAccess(): void;
|
||||||
|
/** @virtual */
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
dequeueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
deleteMe(): void;
|
||||||
|
dispose(): void;
|
||||||
|
private readonly _bindingMap;
|
||||||
|
initObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
getObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
setInstanceData(data: number, finalize_cb: number, finalize_hint: number): void;
|
||||||
|
getInstanceData(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
declare interface External_2 extends Record<any, any> {
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
declare const External_2: {
|
||||||
|
new (value: number | bigint): External_2;
|
||||||
|
prototype: null;
|
||||||
|
};
|
||||||
|
export { External_2 as External }
|
||||||
|
|
||||||
|
export declare class Finalizer {
|
||||||
|
envObject: Env;
|
||||||
|
private _finalizeCallback;
|
||||||
|
private _finalizeData;
|
||||||
|
private _finalizeHint;
|
||||||
|
private _makeDynCall_vppp;
|
||||||
|
constructor(envObject: Env, _finalizeCallback?: napi_finalize, _finalizeData?: void_p, _finalizeHint?: void_p);
|
||||||
|
callback(): napi_finalize;
|
||||||
|
data(): void_p;
|
||||||
|
hint(): void_p;
|
||||||
|
resetEnv(): void;
|
||||||
|
resetFinalizer(): void;
|
||||||
|
callFinalizer(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare function getDefaultContext(): Context;
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare function getExternalValue(external: External_2): number | bigint;
|
||||||
|
|
||||||
|
export declare class Handle<S> {
|
||||||
|
id: number;
|
||||||
|
value: S;
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
data(): void_p;
|
||||||
|
isNumber(): boolean;
|
||||||
|
isBigInt(): boolean;
|
||||||
|
isString(): boolean;
|
||||||
|
isFunction(): boolean;
|
||||||
|
isExternal(): boolean;
|
||||||
|
isObject(): boolean;
|
||||||
|
isArray(): boolean;
|
||||||
|
isArrayBuffer(): boolean;
|
||||||
|
isTypedArray(): boolean;
|
||||||
|
isBuffer(BufferConstructor?: BufferCtor): boolean;
|
||||||
|
isDataView(): boolean;
|
||||||
|
isDate(): boolean;
|
||||||
|
isPromise(): boolean;
|
||||||
|
isBoolean(): boolean;
|
||||||
|
isUndefined(): boolean;
|
||||||
|
isSymbol(): boolean;
|
||||||
|
isNull(): boolean;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class HandleScope {
|
||||||
|
handleStore: HandleStore;
|
||||||
|
id: number;
|
||||||
|
parent: HandleScope | null;
|
||||||
|
child: HandleScope | null;
|
||||||
|
start: number;
|
||||||
|
end: number;
|
||||||
|
private _escapeCalled;
|
||||||
|
callbackInfo: ICallbackInfo;
|
||||||
|
constructor(handleStore: HandleStore, id: number, parentScope: HandleScope | null, start: number, end?: number);
|
||||||
|
add<V>(value: V): Handle<V>;
|
||||||
|
addExternal(data: void_p): Handle<object>;
|
||||||
|
dispose(): void;
|
||||||
|
escape(handle: number): Handle<any> | null;
|
||||||
|
escapeCalled(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class HandleStore {
|
||||||
|
static UNDEFINED: ConstHandle<undefined>;
|
||||||
|
static NULL: ConstHandle<null>;
|
||||||
|
static FALSE: ConstHandle<false>;
|
||||||
|
static TRUE: ConstHandle<true>;
|
||||||
|
static GLOBAL: ConstHandle<typeof globalThis>;
|
||||||
|
static MIN_ID: 6;
|
||||||
|
private readonly _values;
|
||||||
|
private _next;
|
||||||
|
push<S>(value: S): Handle<S>;
|
||||||
|
erase(start: number, end: number): void;
|
||||||
|
get(id: Ptr): Handle<any> | undefined;
|
||||||
|
swap(a: number, b: number): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface ICallbackInfo {
|
||||||
|
thiz: any;
|
||||||
|
data: void_p;
|
||||||
|
args: ArrayLike<any>;
|
||||||
|
fn: Function;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface IDeferrdValue<T = any> {
|
||||||
|
resolve: (value: T) => void;
|
||||||
|
reject: (reason?: any) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface IReferenceBinding {
|
||||||
|
wrapped: number;
|
||||||
|
tag: Uint32Array | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare function isExternal(object: unknown): object is External_2;
|
||||||
|
|
||||||
|
export declare function isReferenceType(v: any): v is object;
|
||||||
|
|
||||||
|
export declare interface IStoreValue {
|
||||||
|
id: number;
|
||||||
|
dispose(): void;
|
||||||
|
[x: string]: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const NAPI_VERSION_EXPERIMENTAL = Version.NAPI_VERSION_EXPERIMENTAL;
|
||||||
|
|
||||||
|
export declare const NODE_API_DEFAULT_MODULE_API_VERSION = Version.NODE_API_DEFAULT_MODULE_API_VERSION;
|
||||||
|
|
||||||
|
export declare const NODE_API_SUPPORTED_VERSION_MAX = Version.NODE_API_SUPPORTED_VERSION_MAX;
|
||||||
|
|
||||||
|
export declare const NODE_API_SUPPORTED_VERSION_MIN = Version.NODE_API_SUPPORTED_VERSION_MIN;
|
||||||
|
|
||||||
|
export declare class NodeEnv extends Env {
|
||||||
|
filename: string;
|
||||||
|
private readonly nodeBinding?;
|
||||||
|
destructing: boolean;
|
||||||
|
finalizationScheduled: boolean;
|
||||||
|
constructor(ctx: Context, filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any);
|
||||||
|
deleteMe(): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
triggerFatalException(err: any): void;
|
||||||
|
callbackIntoModule<T>(enforceUncaughtExceptionPolicy: boolean, fn: (env: Env) => T): T;
|
||||||
|
callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
callFinalizerInternal(forceUncaught: int, cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
drainFinalizerQueue(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class NotSupportBufferError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class NotSupportWeakRefError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Persistent<T> {
|
||||||
|
private _ref;
|
||||||
|
private _param;
|
||||||
|
private _callback;
|
||||||
|
private static readonly _registry;
|
||||||
|
constructor(value: T);
|
||||||
|
setWeak<P>(param: P, callback: (param: P) => void): void;
|
||||||
|
clearWeak(): void;
|
||||||
|
reset(): void;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
deref(): T | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Reference extends RefTracker implements IStoreValue {
|
||||||
|
private static weakCallback;
|
||||||
|
id: number;
|
||||||
|
envObject: Env;
|
||||||
|
private readonly canBeWeak;
|
||||||
|
private _refcount;
|
||||||
|
private readonly _ownership;
|
||||||
|
persistent: Persistent<object>;
|
||||||
|
static create(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, _unused1?: void_p, _unused2?: void_p, _unused3?: void_p): Reference;
|
||||||
|
protected constructor(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership);
|
||||||
|
ref(): number;
|
||||||
|
unref(): number;
|
||||||
|
get(envObject?: Env): napi_value;
|
||||||
|
/** @virtual */
|
||||||
|
resetFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
data(): void_p;
|
||||||
|
refcount(): number;
|
||||||
|
ownership(): ReferenceOwnership;
|
||||||
|
/** @virtual */
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
private _setWeak;
|
||||||
|
finalize(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare enum ReferenceOwnership {
|
||||||
|
kRuntime = 0,
|
||||||
|
kUserland = 1
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ReferenceWithData extends Reference {
|
||||||
|
private readonly _data;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): ReferenceWithData;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ReferenceWithFinalizer extends Reference {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): ReferenceWithFinalizer;
|
||||||
|
private constructor();
|
||||||
|
resetFinalizer(): void;
|
||||||
|
data(): void_p;
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class RefTracker {
|
||||||
|
/** @virtual */
|
||||||
|
dispose(): void;
|
||||||
|
/** @virtual */
|
||||||
|
finalize(): void;
|
||||||
|
private _next;
|
||||||
|
private _prev;
|
||||||
|
link(list: RefTracker): void;
|
||||||
|
unlink(): void;
|
||||||
|
static finalizeAll(list: RefTracker): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ScopeStore {
|
||||||
|
private readonly _rootScope;
|
||||||
|
currentScope: HandleScope;
|
||||||
|
private readonly _values;
|
||||||
|
constructor();
|
||||||
|
get(id: number): HandleScope | undefined;
|
||||||
|
openScope(handleStore: HandleStore): HandleScope;
|
||||||
|
closeScope(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Store<V extends IStoreValue> {
|
||||||
|
protected _values: Array<V | undefined>;
|
||||||
|
private _freeList;
|
||||||
|
private _size;
|
||||||
|
constructor();
|
||||||
|
add(value: V): void;
|
||||||
|
get(id: Ptr): V | undefined;
|
||||||
|
has(id: Ptr): boolean;
|
||||||
|
remove(id: Ptr): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class TrackedFinalizer extends RefTracker {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
dispose(): void;
|
||||||
|
finalize(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class TryCatch {
|
||||||
|
private _exception;
|
||||||
|
private _caught;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
hasCaught(): boolean;
|
||||||
|
exception(): any;
|
||||||
|
setError(err: any): void;
|
||||||
|
reset(): void;
|
||||||
|
extractException(): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const version: string;
|
||||||
|
|
||||||
|
export { }
|
||||||
|
|
||||||
|
export as namespace emnapi;
|
||||||
+1410
File diff suppressed because it is too large
Load Diff
+420
@@ -0,0 +1,420 @@
|
|||||||
|
declare namespace emnapi {
|
||||||
|
|
||||||
|
export type CleanupHookCallbackFunction = number | ((arg: number) => void);
|
||||||
|
|
||||||
|
export class ConstHandle<S extends undefined | null | boolean | typeof globalThis> extends Handle<S> {
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class Context {
|
||||||
|
private _isStopping;
|
||||||
|
private _canCallIntoJs;
|
||||||
|
private _suppressDestroy;
|
||||||
|
envStore: Store<Env>;
|
||||||
|
scopeStore: ScopeStore;
|
||||||
|
refStore: Store<Reference>;
|
||||||
|
deferredStore: Store<Deferred<any>>;
|
||||||
|
handleStore: HandleStore;
|
||||||
|
private readonly refCounter?;
|
||||||
|
private readonly cleanupQueue;
|
||||||
|
feature: {
|
||||||
|
supportReflect: boolean;
|
||||||
|
supportFinalizer: boolean;
|
||||||
|
supportWeakSymbol: boolean;
|
||||||
|
supportBigInt: boolean;
|
||||||
|
supportNewFunction: boolean;
|
||||||
|
canSetFunctionName: boolean;
|
||||||
|
setImmediate: (callback: () => void) => void;
|
||||||
|
Buffer: BufferCtor | undefined;
|
||||||
|
MessageChannel: {
|
||||||
|
new (): MessageChannel;
|
||||||
|
prototype: MessageChannel;
|
||||||
|
} | undefined;
|
||||||
|
};
|
||||||
|
constructor();
|
||||||
|
/**
|
||||||
|
* Suppress the destroy on `beforeExit` event in Node.js.
|
||||||
|
* Call this method if you want to keep the context and
|
||||||
|
* all associated {@link Env | Env} alive,
|
||||||
|
* this also means that cleanup hooks will not be called.
|
||||||
|
* After call this method, you should call
|
||||||
|
* {@link Context.destroy | `Context.prototype.destroy`} method manually.
|
||||||
|
*/
|
||||||
|
suppressDestroy(): void;
|
||||||
|
getRuntimeVersions(): {
|
||||||
|
version: string;
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX: Version;
|
||||||
|
NAPI_VERSION_EXPERIMENTAL: Version;
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION: Version;
|
||||||
|
};
|
||||||
|
createNotSupportWeakRefError(api: string, message: string): NotSupportWeakRefError;
|
||||||
|
createNotSupportBufferError(api: string, message: string): NotSupportBufferError;
|
||||||
|
createReference(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership): Reference;
|
||||||
|
createReferenceWithData(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): Reference;
|
||||||
|
createReferenceWithFinalizer(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback?: napi_finalize, finalize_data?: void_p, finalize_hint?: void_p): Reference;
|
||||||
|
createDeferred<T = any>(value: IDeferrdValue<T>): Deferred<T>;
|
||||||
|
createEnv(filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any): Env;
|
||||||
|
createTrackedFinalizer(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
getCurrentScope(): HandleScope | null;
|
||||||
|
addToCurrentScope<V>(value: V): Handle<V>;
|
||||||
|
openScope(envObject?: Env): HandleScope;
|
||||||
|
closeScope(envObject?: Env, _scope?: HandleScope): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
addCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
removeCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
runCleanup(): void;
|
||||||
|
increaseWaitingRequestCounter(): void;
|
||||||
|
decreaseWaitingRequestCounter(): void;
|
||||||
|
setCanCallIntoJs(value: boolean): void;
|
||||||
|
setStopping(value: boolean): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
/**
|
||||||
|
* Destroy the context and call cleanup hooks.
|
||||||
|
* Associated {@link Env | Env} will be destroyed.
|
||||||
|
*/
|
||||||
|
destroy(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function createContext(): Context;
|
||||||
|
|
||||||
|
export class Deferred<T = any> implements IStoreValue {
|
||||||
|
static create<T = any>(ctx: Context, value: IDeferrdValue<T>): Deferred;
|
||||||
|
id: number;
|
||||||
|
ctx: Context;
|
||||||
|
value: IDeferrdValue<T>;
|
||||||
|
constructor(ctx: Context, value: IDeferrdValue<T>);
|
||||||
|
resolve(value: T): void;
|
||||||
|
reject(reason?: any): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class EmnapiError extends Error {
|
||||||
|
constructor(message?: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export abstract class Env implements IStoreValue {
|
||||||
|
readonly ctx: Context;
|
||||||
|
moduleApiVersion: number;
|
||||||
|
makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void;
|
||||||
|
makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void;
|
||||||
|
abort: (msg?: string) => never;
|
||||||
|
id: number;
|
||||||
|
openHandleScopes: number;
|
||||||
|
instanceData: TrackedFinalizer | null;
|
||||||
|
tryCatch: TryCatch;
|
||||||
|
refs: number;
|
||||||
|
reflist: RefTracker;
|
||||||
|
finalizing_reflist: RefTracker;
|
||||||
|
pendingFinalizers: RefTracker[];
|
||||||
|
lastError: {
|
||||||
|
errorCode: napi_status;
|
||||||
|
engineErrorCode: number;
|
||||||
|
engineReserved: Ptr;
|
||||||
|
};
|
||||||
|
inGcFinalizer: boolean;
|
||||||
|
constructor(ctx: Context, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never);
|
||||||
|
/** @virtual */
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
terminatedOrTerminating(): boolean;
|
||||||
|
ref(): void;
|
||||||
|
unref(): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
ensureHandleId(value: any): napi_value;
|
||||||
|
clearLastError(): napi_status;
|
||||||
|
setLastError(error_code: napi_status, engine_error_code?: uint32_t, engine_reserved?: void_p): napi_status;
|
||||||
|
getReturnStatus(): napi_status;
|
||||||
|
callIntoModule<T>(fn: (env: Env) => T, handleException?: (envObject: Env, value: any) => void): T;
|
||||||
|
/** @virtual */
|
||||||
|
abstract callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
invokeFinalizerFromGC(finalizer: RefTracker): void;
|
||||||
|
checkGCAccess(): void;
|
||||||
|
/** @virtual */
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
dequeueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
deleteMe(): void;
|
||||||
|
dispose(): void;
|
||||||
|
private readonly _bindingMap;
|
||||||
|
initObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
getObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
setInstanceData(data: number, finalize_cb: number, finalize_hint: number): void;
|
||||||
|
getInstanceData(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
interface External_2 extends Record<any, any> {
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
const External_2: {
|
||||||
|
new (value: number | bigint): External_2;
|
||||||
|
prototype: null;
|
||||||
|
};
|
||||||
|
export { External_2 as External }
|
||||||
|
|
||||||
|
export class Finalizer {
|
||||||
|
envObject: Env;
|
||||||
|
private _finalizeCallback;
|
||||||
|
private _finalizeData;
|
||||||
|
private _finalizeHint;
|
||||||
|
private _makeDynCall_vppp;
|
||||||
|
constructor(envObject: Env, _finalizeCallback?: napi_finalize, _finalizeData?: void_p, _finalizeHint?: void_p);
|
||||||
|
callback(): napi_finalize;
|
||||||
|
data(): void_p;
|
||||||
|
hint(): void_p;
|
||||||
|
resetEnv(): void;
|
||||||
|
resetFinalizer(): void;
|
||||||
|
callFinalizer(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getDefaultContext(): Context;
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export function getExternalValue(external: External_2): number | bigint;
|
||||||
|
|
||||||
|
export class Handle<S> {
|
||||||
|
id: number;
|
||||||
|
value: S;
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
data(): void_p;
|
||||||
|
isNumber(): boolean;
|
||||||
|
isBigInt(): boolean;
|
||||||
|
isString(): boolean;
|
||||||
|
isFunction(): boolean;
|
||||||
|
isExternal(): boolean;
|
||||||
|
isObject(): boolean;
|
||||||
|
isArray(): boolean;
|
||||||
|
isArrayBuffer(): boolean;
|
||||||
|
isTypedArray(): boolean;
|
||||||
|
isBuffer(BufferConstructor?: BufferCtor): boolean;
|
||||||
|
isDataView(): boolean;
|
||||||
|
isDate(): boolean;
|
||||||
|
isPromise(): boolean;
|
||||||
|
isBoolean(): boolean;
|
||||||
|
isUndefined(): boolean;
|
||||||
|
isSymbol(): boolean;
|
||||||
|
isNull(): boolean;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class HandleScope {
|
||||||
|
handleStore: HandleStore;
|
||||||
|
id: number;
|
||||||
|
parent: HandleScope | null;
|
||||||
|
child: HandleScope | null;
|
||||||
|
start: number;
|
||||||
|
end: number;
|
||||||
|
private _escapeCalled;
|
||||||
|
callbackInfo: ICallbackInfo;
|
||||||
|
constructor(handleStore: HandleStore, id: number, parentScope: HandleScope | null, start: number, end?: number);
|
||||||
|
add<V>(value: V): Handle<V>;
|
||||||
|
addExternal(data: void_p): Handle<object>;
|
||||||
|
dispose(): void;
|
||||||
|
escape(handle: number): Handle<any> | null;
|
||||||
|
escapeCalled(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class HandleStore {
|
||||||
|
static UNDEFINED: ConstHandle<undefined>;
|
||||||
|
static NULL: ConstHandle<null>;
|
||||||
|
static FALSE: ConstHandle<false>;
|
||||||
|
static TRUE: ConstHandle<true>;
|
||||||
|
static GLOBAL: ConstHandle<typeof globalThis>;
|
||||||
|
static MIN_ID: 6;
|
||||||
|
private readonly _values;
|
||||||
|
private _next;
|
||||||
|
push<S>(value: S): Handle<S>;
|
||||||
|
erase(start: number, end: number): void;
|
||||||
|
get(id: Ptr): Handle<any> | undefined;
|
||||||
|
swap(a: number, b: number): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ICallbackInfo {
|
||||||
|
thiz: any;
|
||||||
|
data: void_p;
|
||||||
|
args: ArrayLike<any>;
|
||||||
|
fn: Function;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IDeferrdValue<T = any> {
|
||||||
|
resolve: (value: T) => void;
|
||||||
|
reject: (reason?: any) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IReferenceBinding {
|
||||||
|
wrapped: number;
|
||||||
|
tag: Uint32Array | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export function isExternal(object: unknown): object is External_2;
|
||||||
|
|
||||||
|
export function isReferenceType(v: any): v is object;
|
||||||
|
|
||||||
|
export interface IStoreValue {
|
||||||
|
id: number;
|
||||||
|
dispose(): void;
|
||||||
|
[x: string]: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const NAPI_VERSION_EXPERIMENTAL = Version.NAPI_VERSION_EXPERIMENTAL;
|
||||||
|
|
||||||
|
export const NODE_API_DEFAULT_MODULE_API_VERSION = Version.NODE_API_DEFAULT_MODULE_API_VERSION;
|
||||||
|
|
||||||
|
export const NODE_API_SUPPORTED_VERSION_MAX = Version.NODE_API_SUPPORTED_VERSION_MAX;
|
||||||
|
|
||||||
|
export const NODE_API_SUPPORTED_VERSION_MIN = Version.NODE_API_SUPPORTED_VERSION_MIN;
|
||||||
|
|
||||||
|
export class NodeEnv extends Env {
|
||||||
|
filename: string;
|
||||||
|
private readonly nodeBinding?;
|
||||||
|
destructing: boolean;
|
||||||
|
finalizationScheduled: boolean;
|
||||||
|
constructor(ctx: Context, filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any);
|
||||||
|
deleteMe(): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
triggerFatalException(err: any): void;
|
||||||
|
callbackIntoModule<T>(enforceUncaughtExceptionPolicy: boolean, fn: (env: Env) => T): T;
|
||||||
|
callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
callFinalizerInternal(forceUncaught: int, cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
drainFinalizerQueue(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class NotSupportBufferError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export class NotSupportWeakRefError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export class Persistent<T> {
|
||||||
|
private _ref;
|
||||||
|
private _param;
|
||||||
|
private _callback;
|
||||||
|
private static readonly _registry;
|
||||||
|
constructor(value: T);
|
||||||
|
setWeak<P>(param: P, callback: (param: P) => void): void;
|
||||||
|
clearWeak(): void;
|
||||||
|
reset(): void;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
deref(): T | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class Reference extends RefTracker implements IStoreValue {
|
||||||
|
private static weakCallback;
|
||||||
|
id: number;
|
||||||
|
envObject: Env;
|
||||||
|
private readonly canBeWeak;
|
||||||
|
private _refcount;
|
||||||
|
private readonly _ownership;
|
||||||
|
persistent: Persistent<object>;
|
||||||
|
static create(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, _unused1?: void_p, _unused2?: void_p, _unused3?: void_p): Reference;
|
||||||
|
protected constructor(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership);
|
||||||
|
ref(): number;
|
||||||
|
unref(): number;
|
||||||
|
get(envObject?: Env): napi_value;
|
||||||
|
/** @virtual */
|
||||||
|
resetFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
data(): void_p;
|
||||||
|
refcount(): number;
|
||||||
|
ownership(): ReferenceOwnership;
|
||||||
|
/** @virtual */
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
private _setWeak;
|
||||||
|
finalize(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum ReferenceOwnership {
|
||||||
|
kRuntime = 0,
|
||||||
|
kUserland = 1
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ReferenceWithData extends Reference {
|
||||||
|
private readonly _data;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): ReferenceWithData;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ReferenceWithFinalizer extends Reference {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): ReferenceWithFinalizer;
|
||||||
|
private constructor();
|
||||||
|
resetFinalizer(): void;
|
||||||
|
data(): void_p;
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class RefTracker {
|
||||||
|
/** @virtual */
|
||||||
|
dispose(): void;
|
||||||
|
/** @virtual */
|
||||||
|
finalize(): void;
|
||||||
|
private _next;
|
||||||
|
private _prev;
|
||||||
|
link(list: RefTracker): void;
|
||||||
|
unlink(): void;
|
||||||
|
static finalizeAll(list: RefTracker): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ScopeStore {
|
||||||
|
private readonly _rootScope;
|
||||||
|
currentScope: HandleScope;
|
||||||
|
private readonly _values;
|
||||||
|
constructor();
|
||||||
|
get(id: number): HandleScope | undefined;
|
||||||
|
openScope(handleStore: HandleStore): HandleScope;
|
||||||
|
closeScope(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class Store<V extends IStoreValue> {
|
||||||
|
protected _values: Array<V | undefined>;
|
||||||
|
private _freeList;
|
||||||
|
private _size;
|
||||||
|
constructor();
|
||||||
|
add(value: V): void;
|
||||||
|
get(id: Ptr): V | undefined;
|
||||||
|
has(id: Ptr): boolean;
|
||||||
|
remove(id: Ptr): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class TrackedFinalizer extends RefTracker {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
dispose(): void;
|
||||||
|
finalize(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class TryCatch {
|
||||||
|
private _exception;
|
||||||
|
private _caught;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
hasCaught(): boolean;
|
||||||
|
exception(): any;
|
||||||
|
setError(err: any): void;
|
||||||
|
reset(): void;
|
||||||
|
extractException(): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const version: string;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
+1481
File diff suppressed because it is too large
Load Diff
+1482
File diff suppressed because it is too large
Load Diff
+665
@@ -0,0 +1,665 @@
|
|||||||
|
export declare type Ptr = number | bigint
|
||||||
|
|
||||||
|
export declare interface IBuffer extends Uint8Array {}
|
||||||
|
export declare interface BufferCtor {
|
||||||
|
readonly prototype: IBuffer
|
||||||
|
/** @deprecated */
|
||||||
|
new (...args: any[]): IBuffer
|
||||||
|
from: {
|
||||||
|
(buffer: ArrayBufferLike): IBuffer
|
||||||
|
(buffer: ArrayBufferLike, byteOffset: number, length: number): IBuffer
|
||||||
|
}
|
||||||
|
alloc: (size: number) => IBuffer
|
||||||
|
isBuffer: (obj: unknown) => obj is IBuffer
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum GlobalHandle {
|
||||||
|
UNDEFINED = 1,
|
||||||
|
NULL,
|
||||||
|
FALSE,
|
||||||
|
TRUE,
|
||||||
|
GLOBAL
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum Version {
|
||||||
|
NODE_API_SUPPORTED_VERSION_MIN = 1,
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION = 8,
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX = 10,
|
||||||
|
NAPI_VERSION_EXPERIMENTAL = 2147483647 // INT_MAX
|
||||||
|
}
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
|
export declare type Pointer<T> = number
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||||
|
export declare type PointerPointer<T> = number
|
||||||
|
export declare type FunctionPointer<T extends (...args: any[]) => any> = Pointer<T>
|
||||||
|
export declare type Const<T> = T
|
||||||
|
|
||||||
|
export declare type void_p = Pointer<void>
|
||||||
|
export declare type void_pp = Pointer<void_p>
|
||||||
|
export declare type bool = number
|
||||||
|
export declare type char = number
|
||||||
|
export declare type char_p = Pointer<char>
|
||||||
|
export declare type unsigned_char = number
|
||||||
|
export declare type const_char = Const<char>
|
||||||
|
export declare type const_char_p = Pointer<const_char>
|
||||||
|
export declare type char16_t_p = number
|
||||||
|
export declare type const_char16_t_p = number
|
||||||
|
|
||||||
|
export declare type short = number
|
||||||
|
export declare type unsigned_short = number
|
||||||
|
export declare type int = number
|
||||||
|
export declare type unsigned_int = number
|
||||||
|
export declare type long = number
|
||||||
|
export declare type unsigned_long = number
|
||||||
|
export declare type long_long = bigint
|
||||||
|
export declare type unsigned_long_long = bigint
|
||||||
|
export declare type float = number
|
||||||
|
export declare type double = number
|
||||||
|
export declare type long_double = number
|
||||||
|
export declare type size_t = number
|
||||||
|
|
||||||
|
export declare type int8_t = number
|
||||||
|
export declare type uint8_t = number
|
||||||
|
export declare type int16_t = number
|
||||||
|
export declare type uint16_t = number
|
||||||
|
export declare type int32_t = number
|
||||||
|
export declare type uint32_t = number
|
||||||
|
export declare type int64_t = bigint
|
||||||
|
export declare type uint64_t = bigint
|
||||||
|
export declare type napi_env = Pointer<unknown>
|
||||||
|
|
||||||
|
export declare type napi_value = Pointer<unknown>
|
||||||
|
export declare type napi_ref = Pointer<unknown>
|
||||||
|
export declare type napi_deferred = Pointer<unknown>
|
||||||
|
export declare type napi_handle_scope = Pointer<unknown>
|
||||||
|
export declare type napi_escapable_handle_scope = Pointer<unknown>
|
||||||
|
|
||||||
|
export declare type napi_addon_register_func = FunctionPointer<(env: napi_env, exports: napi_value) => napi_value>
|
||||||
|
|
||||||
|
export declare type napi_callback_info = Pointer<unknown>
|
||||||
|
export declare type napi_callback = FunctionPointer<(env: napi_env, info: napi_callback_info) => napi_value>
|
||||||
|
|
||||||
|
export declare interface napi_extended_error_info {
|
||||||
|
error_message: const_char_p
|
||||||
|
engine_reserved: void_p
|
||||||
|
engine_error_code: uint32_t
|
||||||
|
error_code: napi_status
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface napi_property_descriptor {
|
||||||
|
// One of utf8name or name should be NULL.
|
||||||
|
utf8name: const_char_p
|
||||||
|
name: napi_value
|
||||||
|
|
||||||
|
method: napi_callback
|
||||||
|
getter: napi_callback
|
||||||
|
setter: napi_callback
|
||||||
|
value: napi_value
|
||||||
|
/* napi_property_attributes */
|
||||||
|
attributes: number
|
||||||
|
data: void_p
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare type napi_finalize = FunctionPointer<(
|
||||||
|
env: napi_env,
|
||||||
|
finalize_data: void_p,
|
||||||
|
finalize_hint: void_p
|
||||||
|
) => void>
|
||||||
|
|
||||||
|
export declare interface node_module {
|
||||||
|
nm_version: int32_t
|
||||||
|
nm_flags: uint32_t
|
||||||
|
nm_filename: Pointer<const_char>
|
||||||
|
nm_register_func: napi_addon_register_func
|
||||||
|
nm_modname: Pointer<const_char>
|
||||||
|
nm_priv: Pointer<void>
|
||||||
|
reserved: PointerPointer<void>
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface napi_node_version {
|
||||||
|
major: uint32_t
|
||||||
|
minor: uint32_t
|
||||||
|
patch: uint32_t
|
||||||
|
release: const_char_p
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface emnapi_emscripten_version {
|
||||||
|
major: uint32_t
|
||||||
|
minor: uint32_t
|
||||||
|
patch: uint32_t
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_status {
|
||||||
|
napi_ok,
|
||||||
|
napi_invalid_arg,
|
||||||
|
napi_object_expected,
|
||||||
|
napi_string_expected,
|
||||||
|
napi_name_expected,
|
||||||
|
napi_function_expected,
|
||||||
|
napi_number_expected,
|
||||||
|
napi_boolean_expected,
|
||||||
|
napi_array_expected,
|
||||||
|
napi_generic_failure,
|
||||||
|
napi_pending_exception,
|
||||||
|
napi_cancelled,
|
||||||
|
napi_escape_called_twice,
|
||||||
|
napi_handle_scope_mismatch,
|
||||||
|
napi_callback_scope_mismatch,
|
||||||
|
napi_queue_full,
|
||||||
|
napi_closing,
|
||||||
|
napi_bigint_expected,
|
||||||
|
napi_date_expected,
|
||||||
|
napi_arraybuffer_expected,
|
||||||
|
napi_detachable_arraybuffer_expected,
|
||||||
|
napi_would_deadlock, // unused
|
||||||
|
napi_no_external_buffers_allowed,
|
||||||
|
napi_cannot_run_js
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_property_attributes {
|
||||||
|
napi_default = 0,
|
||||||
|
napi_writable = 1 << 0,
|
||||||
|
napi_enumerable = 1 << 1,
|
||||||
|
napi_configurable = 1 << 2,
|
||||||
|
|
||||||
|
// Used with napi_define_class to distinguish static properties
|
||||||
|
// from instance properties. Ignored by napi_define_properties.
|
||||||
|
napi_static = 1 << 10,
|
||||||
|
|
||||||
|
/// #ifdef NAPI_EXPERIMENTAL
|
||||||
|
// Default for class methods.
|
||||||
|
napi_default_method = napi_writable | napi_configurable,
|
||||||
|
|
||||||
|
// Default for object properties, like in JS obj[prop].
|
||||||
|
napi_default_jsproperty = napi_writable | napi_enumerable | napi_configurable
|
||||||
|
/// #endif // NAPI_EXPERIMENTAL
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_valuetype {
|
||||||
|
napi_undefined,
|
||||||
|
napi_null,
|
||||||
|
napi_boolean,
|
||||||
|
napi_number,
|
||||||
|
napi_string,
|
||||||
|
napi_symbol,
|
||||||
|
napi_object,
|
||||||
|
napi_function,
|
||||||
|
napi_external,
|
||||||
|
napi_bigint
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_typedarray_type {
|
||||||
|
napi_int8_array,
|
||||||
|
napi_uint8_array,
|
||||||
|
napi_uint8_clamped_array,
|
||||||
|
napi_int16_array,
|
||||||
|
napi_uint16_array,
|
||||||
|
napi_int32_array,
|
||||||
|
napi_uint32_array,
|
||||||
|
napi_float32_array,
|
||||||
|
napi_float64_array,
|
||||||
|
napi_bigint64_array,
|
||||||
|
napi_biguint64_array,
|
||||||
|
napi_float16_array,
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_collection_mode {
|
||||||
|
napi_key_include_prototypes,
|
||||||
|
napi_key_own_only
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_filter {
|
||||||
|
napi_key_all_properties = 0,
|
||||||
|
napi_key_writable = 1,
|
||||||
|
napi_key_enumerable = 1 << 1,
|
||||||
|
napi_key_configurable = 1 << 2,
|
||||||
|
napi_key_skip_strings = 1 << 3,
|
||||||
|
napi_key_skip_symbols = 1 << 4
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_key_conversion {
|
||||||
|
napi_key_keep_numbers,
|
||||||
|
napi_key_numbers_to_strings
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum emnapi_memory_view_type {
|
||||||
|
emnapi_int8_array,
|
||||||
|
emnapi_uint8_array,
|
||||||
|
emnapi_uint8_clamped_array,
|
||||||
|
emnapi_int16_array,
|
||||||
|
emnapi_uint16_array,
|
||||||
|
emnapi_int32_array,
|
||||||
|
emnapi_uint32_array,
|
||||||
|
emnapi_float32_array,
|
||||||
|
emnapi_float64_array,
|
||||||
|
emnapi_bigint64_array,
|
||||||
|
emnapi_biguint64_array,
|
||||||
|
emnapi_float16_array,
|
||||||
|
emnapi_data_view = -1,
|
||||||
|
emnapi_buffer = -2
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_threadsafe_function_call_mode {
|
||||||
|
napi_tsfn_nonblocking,
|
||||||
|
napi_tsfn_blocking
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const enum napi_threadsafe_function_release_mode {
|
||||||
|
napi_tsfn_release,
|
||||||
|
napi_tsfn_abort
|
||||||
|
}
|
||||||
|
export declare type CleanupHookCallbackFunction = number | ((arg: number) => void);
|
||||||
|
|
||||||
|
export declare class ConstHandle<S extends undefined | null | boolean | typeof globalThis> extends Handle<S> {
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Context {
|
||||||
|
private _isStopping;
|
||||||
|
private _canCallIntoJs;
|
||||||
|
private _suppressDestroy;
|
||||||
|
envStore: Store<Env>;
|
||||||
|
scopeStore: ScopeStore;
|
||||||
|
refStore: Store<Reference>;
|
||||||
|
deferredStore: Store<Deferred<any>>;
|
||||||
|
handleStore: HandleStore;
|
||||||
|
private readonly refCounter?;
|
||||||
|
private readonly cleanupQueue;
|
||||||
|
feature: {
|
||||||
|
supportReflect: boolean;
|
||||||
|
supportFinalizer: boolean;
|
||||||
|
supportWeakSymbol: boolean;
|
||||||
|
supportBigInt: boolean;
|
||||||
|
supportNewFunction: boolean;
|
||||||
|
canSetFunctionName: boolean;
|
||||||
|
setImmediate: (callback: () => void) => void;
|
||||||
|
Buffer: BufferCtor | undefined;
|
||||||
|
MessageChannel: {
|
||||||
|
new (): MessageChannel;
|
||||||
|
prototype: MessageChannel;
|
||||||
|
} | undefined;
|
||||||
|
};
|
||||||
|
constructor();
|
||||||
|
/**
|
||||||
|
* Suppress the destroy on `beforeExit` event in Node.js.
|
||||||
|
* Call this method if you want to keep the context and
|
||||||
|
* all associated {@link Env | Env} alive,
|
||||||
|
* this also means that cleanup hooks will not be called.
|
||||||
|
* After call this method, you should call
|
||||||
|
* {@link Context.destroy | `Context.prototype.destroy`} method manually.
|
||||||
|
*/
|
||||||
|
suppressDestroy(): void;
|
||||||
|
getRuntimeVersions(): {
|
||||||
|
version: string;
|
||||||
|
NODE_API_SUPPORTED_VERSION_MAX: Version;
|
||||||
|
NAPI_VERSION_EXPERIMENTAL: Version;
|
||||||
|
NODE_API_DEFAULT_MODULE_API_VERSION: Version;
|
||||||
|
};
|
||||||
|
createNotSupportWeakRefError(api: string, message: string): NotSupportWeakRefError;
|
||||||
|
createNotSupportBufferError(api: string, message: string): NotSupportBufferError;
|
||||||
|
createReference(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership): Reference;
|
||||||
|
createReferenceWithData(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): Reference;
|
||||||
|
createReferenceWithFinalizer(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback?: napi_finalize, finalize_data?: void_p, finalize_hint?: void_p): Reference;
|
||||||
|
createDeferred<T = any>(value: IDeferrdValue<T>): Deferred<T>;
|
||||||
|
createEnv(filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any): Env;
|
||||||
|
createTrackedFinalizer(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
getCurrentScope(): HandleScope | null;
|
||||||
|
addToCurrentScope<V>(value: V): Handle<V>;
|
||||||
|
openScope(envObject?: Env): HandleScope;
|
||||||
|
closeScope(envObject?: Env, _scope?: HandleScope): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
addCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
removeCleanupHook(envObject: Env, fn: CleanupHookCallbackFunction, arg: number): void;
|
||||||
|
runCleanup(): void;
|
||||||
|
increaseWaitingRequestCounter(): void;
|
||||||
|
decreaseWaitingRequestCounter(): void;
|
||||||
|
setCanCallIntoJs(value: boolean): void;
|
||||||
|
setStopping(value: boolean): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
/**
|
||||||
|
* Destroy the context and call cleanup hooks.
|
||||||
|
* Associated {@link Env | Env} will be destroyed.
|
||||||
|
*/
|
||||||
|
destroy(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare function createContext(): Context;
|
||||||
|
|
||||||
|
export declare class Deferred<T = any> implements IStoreValue {
|
||||||
|
static create<T = any>(ctx: Context, value: IDeferrdValue<T>): Deferred;
|
||||||
|
id: number;
|
||||||
|
ctx: Context;
|
||||||
|
value: IDeferrdValue<T>;
|
||||||
|
constructor(ctx: Context, value: IDeferrdValue<T>);
|
||||||
|
resolve(value: T): void;
|
||||||
|
reject(reason?: any): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class EmnapiError extends Error {
|
||||||
|
constructor(message?: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare abstract class Env implements IStoreValue {
|
||||||
|
readonly ctx: Context;
|
||||||
|
moduleApiVersion: number;
|
||||||
|
makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void;
|
||||||
|
makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void;
|
||||||
|
abort: (msg?: string) => never;
|
||||||
|
id: number;
|
||||||
|
openHandleScopes: number;
|
||||||
|
instanceData: TrackedFinalizer | null;
|
||||||
|
tryCatch: TryCatch;
|
||||||
|
refs: number;
|
||||||
|
reflist: RefTracker;
|
||||||
|
finalizing_reflist: RefTracker;
|
||||||
|
pendingFinalizers: RefTracker[];
|
||||||
|
lastError: {
|
||||||
|
errorCode: napi_status;
|
||||||
|
engineErrorCode: number;
|
||||||
|
engineReserved: Ptr;
|
||||||
|
};
|
||||||
|
inGcFinalizer: boolean;
|
||||||
|
constructor(ctx: Context, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never);
|
||||||
|
/** @virtual */
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
terminatedOrTerminating(): boolean;
|
||||||
|
ref(): void;
|
||||||
|
unref(): void;
|
||||||
|
ensureHandle<S>(value: S): Handle<S>;
|
||||||
|
ensureHandleId(value: any): napi_value;
|
||||||
|
clearLastError(): napi_status;
|
||||||
|
setLastError(error_code: napi_status, engine_error_code?: uint32_t, engine_reserved?: void_p): napi_status;
|
||||||
|
getReturnStatus(): napi_status;
|
||||||
|
callIntoModule<T>(fn: (env: Env) => T, handleException?: (envObject: Env, value: any) => void): T;
|
||||||
|
/** @virtual */
|
||||||
|
abstract callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
invokeFinalizerFromGC(finalizer: RefTracker): void;
|
||||||
|
checkGCAccess(): void;
|
||||||
|
/** @virtual */
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
dequeueFinalizer(finalizer: RefTracker): void;
|
||||||
|
/** @virtual */
|
||||||
|
deleteMe(): void;
|
||||||
|
dispose(): void;
|
||||||
|
private readonly _bindingMap;
|
||||||
|
initObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
getObjectBinding<S extends object>(value: S): IReferenceBinding;
|
||||||
|
setInstanceData(data: number, finalize_cb: number, finalize_hint: number): void;
|
||||||
|
getInstanceData(): number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
declare interface External_2 extends Record<any, any> {
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
declare const External_2: {
|
||||||
|
new (value: number | bigint): External_2;
|
||||||
|
prototype: null;
|
||||||
|
};
|
||||||
|
export { External_2 as External }
|
||||||
|
|
||||||
|
export declare class Finalizer {
|
||||||
|
envObject: Env;
|
||||||
|
private _finalizeCallback;
|
||||||
|
private _finalizeData;
|
||||||
|
private _finalizeHint;
|
||||||
|
private _makeDynCall_vppp;
|
||||||
|
constructor(envObject: Env, _finalizeCallback?: napi_finalize, _finalizeData?: void_p, _finalizeHint?: void_p);
|
||||||
|
callback(): napi_finalize;
|
||||||
|
data(): void_p;
|
||||||
|
hint(): void_p;
|
||||||
|
resetEnv(): void;
|
||||||
|
resetFinalizer(): void;
|
||||||
|
callFinalizer(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare function getDefaultContext(): Context;
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare function getExternalValue(external: External_2): number | bigint;
|
||||||
|
|
||||||
|
export declare class Handle<S> {
|
||||||
|
id: number;
|
||||||
|
value: S;
|
||||||
|
constructor(id: number, value: S);
|
||||||
|
data(): void_p;
|
||||||
|
isNumber(): boolean;
|
||||||
|
isBigInt(): boolean;
|
||||||
|
isString(): boolean;
|
||||||
|
isFunction(): boolean;
|
||||||
|
isExternal(): boolean;
|
||||||
|
isObject(): boolean;
|
||||||
|
isArray(): boolean;
|
||||||
|
isArrayBuffer(): boolean;
|
||||||
|
isTypedArray(): boolean;
|
||||||
|
isBuffer(BufferConstructor?: BufferCtor): boolean;
|
||||||
|
isDataView(): boolean;
|
||||||
|
isDate(): boolean;
|
||||||
|
isPromise(): boolean;
|
||||||
|
isBoolean(): boolean;
|
||||||
|
isUndefined(): boolean;
|
||||||
|
isSymbol(): boolean;
|
||||||
|
isNull(): boolean;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class HandleScope {
|
||||||
|
handleStore: HandleStore;
|
||||||
|
id: number;
|
||||||
|
parent: HandleScope | null;
|
||||||
|
child: HandleScope | null;
|
||||||
|
start: number;
|
||||||
|
end: number;
|
||||||
|
private _escapeCalled;
|
||||||
|
callbackInfo: ICallbackInfo;
|
||||||
|
constructor(handleStore: HandleStore, id: number, parentScope: HandleScope | null, start: number, end?: number);
|
||||||
|
add<V>(value: V): Handle<V>;
|
||||||
|
addExternal(data: void_p): Handle<object>;
|
||||||
|
dispose(): void;
|
||||||
|
escape(handle: number): Handle<any> | null;
|
||||||
|
escapeCalled(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class HandleStore {
|
||||||
|
static UNDEFINED: ConstHandle<undefined>;
|
||||||
|
static NULL: ConstHandle<null>;
|
||||||
|
static FALSE: ConstHandle<false>;
|
||||||
|
static TRUE: ConstHandle<true>;
|
||||||
|
static GLOBAL: ConstHandle<typeof globalThis>;
|
||||||
|
static MIN_ID: 6;
|
||||||
|
private readonly _values;
|
||||||
|
private _next;
|
||||||
|
push<S>(value: S): Handle<S>;
|
||||||
|
erase(start: number, end: number): void;
|
||||||
|
get(id: Ptr): Handle<any> | undefined;
|
||||||
|
swap(a: number, b: number): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface ICallbackInfo {
|
||||||
|
thiz: any;
|
||||||
|
data: void_p;
|
||||||
|
args: ArrayLike<any>;
|
||||||
|
fn: Function;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface IDeferrdValue<T = any> {
|
||||||
|
resolve: (value: T) => void;
|
||||||
|
reject: (reason?: any) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare interface IReferenceBinding {
|
||||||
|
wrapped: number;
|
||||||
|
tag: Uint32Array | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare function isExternal(object: unknown): object is External_2;
|
||||||
|
|
||||||
|
export declare function isReferenceType(v: any): v is object;
|
||||||
|
|
||||||
|
export declare interface IStoreValue {
|
||||||
|
id: number;
|
||||||
|
dispose(): void;
|
||||||
|
[x: string]: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const NAPI_VERSION_EXPERIMENTAL = Version.NAPI_VERSION_EXPERIMENTAL;
|
||||||
|
|
||||||
|
export declare const NODE_API_DEFAULT_MODULE_API_VERSION = Version.NODE_API_DEFAULT_MODULE_API_VERSION;
|
||||||
|
|
||||||
|
export declare const NODE_API_SUPPORTED_VERSION_MAX = Version.NODE_API_SUPPORTED_VERSION_MAX;
|
||||||
|
|
||||||
|
export declare const NODE_API_SUPPORTED_VERSION_MIN = Version.NODE_API_SUPPORTED_VERSION_MIN;
|
||||||
|
|
||||||
|
export declare class NodeEnv extends Env {
|
||||||
|
filename: string;
|
||||||
|
private readonly nodeBinding?;
|
||||||
|
destructing: boolean;
|
||||||
|
finalizationScheduled: boolean;
|
||||||
|
constructor(ctx: Context, filename: string, moduleApiVersion: number, makeDynCall_vppp: (cb: Ptr) => (a: Ptr, b: Ptr, c: Ptr) => void, makeDynCall_vp: (cb: Ptr) => (a: Ptr) => void, abort: (msg?: string) => never, nodeBinding?: any);
|
||||||
|
deleteMe(): void;
|
||||||
|
canCallIntoJs(): boolean;
|
||||||
|
triggerFatalException(err: any): void;
|
||||||
|
callbackIntoModule<T>(enforceUncaughtExceptionPolicy: boolean, fn: (env: Env) => T): T;
|
||||||
|
callFinalizer(cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
callFinalizerInternal(forceUncaught: int, cb: napi_finalize, data: void_p, hint: void_p): void;
|
||||||
|
enqueueFinalizer(finalizer: RefTracker): void;
|
||||||
|
drainFinalizerQueue(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class NotSupportBufferError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class NotSupportWeakRefError extends EmnapiError {
|
||||||
|
constructor(api: string, message: string);
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Persistent<T> {
|
||||||
|
private _ref;
|
||||||
|
private _param;
|
||||||
|
private _callback;
|
||||||
|
private static readonly _registry;
|
||||||
|
constructor(value: T);
|
||||||
|
setWeak<P>(param: P, callback: (param: P) => void): void;
|
||||||
|
clearWeak(): void;
|
||||||
|
reset(): void;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
deref(): T | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Reference extends RefTracker implements IStoreValue {
|
||||||
|
private static weakCallback;
|
||||||
|
id: number;
|
||||||
|
envObject: Env;
|
||||||
|
private readonly canBeWeak;
|
||||||
|
private _refcount;
|
||||||
|
private readonly _ownership;
|
||||||
|
persistent: Persistent<object>;
|
||||||
|
static create(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, _unused1?: void_p, _unused2?: void_p, _unused3?: void_p): Reference;
|
||||||
|
protected constructor(envObject: Env, handle_id: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership);
|
||||||
|
ref(): number;
|
||||||
|
unref(): number;
|
||||||
|
get(envObject?: Env): napi_value;
|
||||||
|
/** @virtual */
|
||||||
|
resetFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
data(): void_p;
|
||||||
|
refcount(): number;
|
||||||
|
ownership(): ReferenceOwnership;
|
||||||
|
/** @virtual */
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
/** @virtual */
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
private _setWeak;
|
||||||
|
finalize(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare enum ReferenceOwnership {
|
||||||
|
kRuntime = 0,
|
||||||
|
kUserland = 1
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ReferenceWithData extends Reference {
|
||||||
|
private readonly _data;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, data: void_p): ReferenceWithData;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ReferenceWithFinalizer extends Reference {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, value: napi_value, initialRefcount: uint32_t, ownership: ReferenceOwnership, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): ReferenceWithFinalizer;
|
||||||
|
private constructor();
|
||||||
|
resetFinalizer(): void;
|
||||||
|
data(): void_p;
|
||||||
|
protected callUserFinalizer(): void;
|
||||||
|
protected invokeFinalizerFromGC(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class RefTracker {
|
||||||
|
/** @virtual */
|
||||||
|
dispose(): void;
|
||||||
|
/** @virtual */
|
||||||
|
finalize(): void;
|
||||||
|
private _next;
|
||||||
|
private _prev;
|
||||||
|
link(list: RefTracker): void;
|
||||||
|
unlink(): void;
|
||||||
|
static finalizeAll(list: RefTracker): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class ScopeStore {
|
||||||
|
private readonly _rootScope;
|
||||||
|
currentScope: HandleScope;
|
||||||
|
private readonly _values;
|
||||||
|
constructor();
|
||||||
|
get(id: number): HandleScope | undefined;
|
||||||
|
openScope(handleStore: HandleStore): HandleScope;
|
||||||
|
closeScope(): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class Store<V extends IStoreValue> {
|
||||||
|
protected _values: Array<V | undefined>;
|
||||||
|
private _freeList;
|
||||||
|
private _size;
|
||||||
|
constructor();
|
||||||
|
add(value: V): void;
|
||||||
|
get(id: Ptr): V | undefined;
|
||||||
|
has(id: Ptr): boolean;
|
||||||
|
remove(id: Ptr): void;
|
||||||
|
dispose(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class TrackedFinalizer extends RefTracker {
|
||||||
|
private _finalizer;
|
||||||
|
static create(envObject: Env, finalize_callback: napi_finalize, finalize_data: void_p, finalize_hint: void_p): TrackedFinalizer;
|
||||||
|
private constructor();
|
||||||
|
data(): void_p;
|
||||||
|
dispose(): void;
|
||||||
|
finalize(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare class TryCatch {
|
||||||
|
private _exception;
|
||||||
|
private _caught;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
hasCaught(): boolean;
|
||||||
|
exception(): any;
|
||||||
|
setError(err: any): void;
|
||||||
|
reset(): void;
|
||||||
|
extractException(): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare const version: string;
|
||||||
|
|
||||||
|
export { }
|
||||||
+1
File diff suppressed because one or more lines are too long
+1
File diff suppressed because one or more lines are too long
+1323
File diff suppressed because it is too large
Load Diff
+5
@@ -0,0 +1,5 @@
|
|||||||
|
if (typeof process !== 'undefined' && process.env.NODE_ENV === 'production') {
|
||||||
|
module.exports = require('./dist/emnapi.cjs.min.js')
|
||||||
|
} else {
|
||||||
|
module.exports = require('./dist/emnapi.cjs.js')
|
||||||
|
}
|
||||||
+48
@@ -0,0 +1,48 @@
|
|||||||
|
{
|
||||||
|
"name": "@emnapi/runtime",
|
||||||
|
"version": "1.9.0",
|
||||||
|
"description": "emnapi runtime",
|
||||||
|
"main": "index.js",
|
||||||
|
"module": "./dist/emnapi.esm-bundler.js",
|
||||||
|
"types": "./dist/emnapi.d.ts",
|
||||||
|
"sideEffects": false,
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": {
|
||||||
|
"module": "./dist/emnapi.d.ts",
|
||||||
|
"import": "./dist/emnapi.d.mts",
|
||||||
|
"default": "./dist/emnapi.d.ts"
|
||||||
|
},
|
||||||
|
"module": "./dist/emnapi.esm-bundler.js",
|
||||||
|
"import": "./dist/emnapi.mjs",
|
||||||
|
"default": "./index.js"
|
||||||
|
},
|
||||||
|
"./dist/emnapi.cjs.min": {
|
||||||
|
"types": "./dist/emnapi.d.ts",
|
||||||
|
"default": "./dist/emnapi.cjs.min.js"
|
||||||
|
},
|
||||||
|
"./dist/emnapi.min.mjs": {
|
||||||
|
"types": "./dist/emnapi.d.mts",
|
||||||
|
"default": "./dist/emnapi.min.mjs"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"tslib": "^2.4.0"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"build": "node ./script/build.js"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/toyobayashi/emnapi.git"
|
||||||
|
},
|
||||||
|
"author": "toyobayashi",
|
||||||
|
"license": "MIT",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/toyobayashi/emnapi/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/toyobayashi/emnapi#readme",
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
|
}
|
||||||
|
}
|
||||||
+21
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE
|
||||||
+15
@@ -0,0 +1,15 @@
|
|||||||
|
# Installation
|
||||||
|
> `npm install --save @types/estree`
|
||||||
|
|
||||||
|
# Summary
|
||||||
|
This package contains type definitions for estree (https://github.com/estree/estree).
|
||||||
|
|
||||||
|
# Details
|
||||||
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/estree.
|
||||||
|
|
||||||
|
### Additional Details
|
||||||
|
* Last updated: Fri, 06 Jun 2025 00:04:33 GMT
|
||||||
|
* Dependencies: none
|
||||||
|
|
||||||
|
# Credits
|
||||||
|
These definitions were written by [RReverser](https://github.com/RReverser).
|
||||||
+167
@@ -0,0 +1,167 @@
|
|||||||
|
declare namespace ESTree {
|
||||||
|
interface FlowTypeAnnotation extends Node {}
|
||||||
|
|
||||||
|
interface FlowBaseTypeAnnotation extends FlowTypeAnnotation {}
|
||||||
|
|
||||||
|
interface FlowLiteralTypeAnnotation extends FlowTypeAnnotation, Literal {}
|
||||||
|
|
||||||
|
interface FlowDeclaration extends Declaration {}
|
||||||
|
|
||||||
|
interface AnyTypeAnnotation extends FlowBaseTypeAnnotation {}
|
||||||
|
|
||||||
|
interface ArrayTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
elementType: FlowTypeAnnotation;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface BooleanLiteralTypeAnnotation extends FlowLiteralTypeAnnotation {}
|
||||||
|
|
||||||
|
interface BooleanTypeAnnotation extends FlowBaseTypeAnnotation {}
|
||||||
|
|
||||||
|
interface ClassImplements extends Node {
|
||||||
|
id: Identifier;
|
||||||
|
typeParameters?: TypeParameterInstantiation | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ClassProperty {
|
||||||
|
key: Expression;
|
||||||
|
value?: Expression | null;
|
||||||
|
typeAnnotation?: TypeAnnotation | null;
|
||||||
|
computed: boolean;
|
||||||
|
static: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface DeclareClass extends FlowDeclaration {
|
||||||
|
id: Identifier;
|
||||||
|
typeParameters?: TypeParameterDeclaration | null;
|
||||||
|
body: ObjectTypeAnnotation;
|
||||||
|
extends: InterfaceExtends[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface DeclareFunction extends FlowDeclaration {
|
||||||
|
id: Identifier;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface DeclareModule extends FlowDeclaration {
|
||||||
|
id: Literal | Identifier;
|
||||||
|
body: BlockStatement;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface DeclareVariable extends FlowDeclaration {
|
||||||
|
id: Identifier;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface FunctionTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
params: FunctionTypeParam[];
|
||||||
|
returnType: FlowTypeAnnotation;
|
||||||
|
rest?: FunctionTypeParam | null;
|
||||||
|
typeParameters?: TypeParameterDeclaration | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface FunctionTypeParam {
|
||||||
|
name: Identifier;
|
||||||
|
typeAnnotation: FlowTypeAnnotation;
|
||||||
|
optional: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GenericTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
id: Identifier | QualifiedTypeIdentifier;
|
||||||
|
typeParameters?: TypeParameterInstantiation | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface InterfaceExtends extends Node {
|
||||||
|
id: Identifier | QualifiedTypeIdentifier;
|
||||||
|
typeParameters?: TypeParameterInstantiation | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface InterfaceDeclaration extends FlowDeclaration {
|
||||||
|
id: Identifier;
|
||||||
|
typeParameters?: TypeParameterDeclaration | null;
|
||||||
|
extends: InterfaceExtends[];
|
||||||
|
body: ObjectTypeAnnotation;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface IntersectionTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
types: FlowTypeAnnotation[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface MixedTypeAnnotation extends FlowBaseTypeAnnotation {}
|
||||||
|
|
||||||
|
interface NullableTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
typeAnnotation: TypeAnnotation;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface NumberLiteralTypeAnnotation extends FlowLiteralTypeAnnotation {}
|
||||||
|
|
||||||
|
interface NumberTypeAnnotation extends FlowBaseTypeAnnotation {}
|
||||||
|
|
||||||
|
interface StringLiteralTypeAnnotation extends FlowLiteralTypeAnnotation {}
|
||||||
|
|
||||||
|
interface StringTypeAnnotation extends FlowBaseTypeAnnotation {}
|
||||||
|
|
||||||
|
interface TupleTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
types: FlowTypeAnnotation[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface TypeofTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
argument: FlowTypeAnnotation;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface TypeAlias extends FlowDeclaration {
|
||||||
|
id: Identifier;
|
||||||
|
typeParameters?: TypeParameterDeclaration | null;
|
||||||
|
right: FlowTypeAnnotation;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface TypeAnnotation extends Node {
|
||||||
|
typeAnnotation: FlowTypeAnnotation;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface TypeCastExpression extends Expression {
|
||||||
|
expression: Expression;
|
||||||
|
typeAnnotation: TypeAnnotation;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface TypeParameterDeclaration extends Node {
|
||||||
|
params: Identifier[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface TypeParameterInstantiation extends Node {
|
||||||
|
params: FlowTypeAnnotation[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ObjectTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
properties: ObjectTypeProperty[];
|
||||||
|
indexers: ObjectTypeIndexer[];
|
||||||
|
callProperties: ObjectTypeCallProperty[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ObjectTypeCallProperty extends Node {
|
||||||
|
value: FunctionTypeAnnotation;
|
||||||
|
static: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ObjectTypeIndexer extends Node {
|
||||||
|
id: Identifier;
|
||||||
|
key: FlowTypeAnnotation;
|
||||||
|
value: FlowTypeAnnotation;
|
||||||
|
static: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ObjectTypeProperty extends Node {
|
||||||
|
key: Expression;
|
||||||
|
value: FlowTypeAnnotation;
|
||||||
|
optional: boolean;
|
||||||
|
static: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface QualifiedTypeIdentifier extends Node {
|
||||||
|
qualification: Identifier | QualifiedTypeIdentifier;
|
||||||
|
id: Identifier;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface UnionTypeAnnotation extends FlowTypeAnnotation {
|
||||||
|
types: FlowTypeAnnotation[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface VoidTypeAnnotation extends FlowBaseTypeAnnotation {}
|
||||||
|
}
|
||||||
+694
@@ -0,0 +1,694 @@
|
|||||||
|
// This definition file follows a somewhat unusual format. ESTree allows
|
||||||
|
// runtime type checks based on the `type` parameter. In order to explain this
|
||||||
|
// to typescript we want to use discriminated union types:
|
||||||
|
// https://github.com/Microsoft/TypeScript/pull/9163
|
||||||
|
//
|
||||||
|
// For ESTree this is a bit tricky because the high level interfaces like
|
||||||
|
// Node or Function are pulling double duty. We want to pass common fields down
|
||||||
|
// to the interfaces that extend them (like Identifier or
|
||||||
|
// ArrowFunctionExpression), but you can't extend a type union or enforce
|
||||||
|
// common fields on them. So we've split the high level interfaces into two
|
||||||
|
// types, a base type which passes down inherited fields, and a type union of
|
||||||
|
// all types which extend the base type. Only the type union is exported, and
|
||||||
|
// the union is how other types refer to the collection of inheriting types.
|
||||||
|
//
|
||||||
|
// This makes the definitions file here somewhat more difficult to maintain,
|
||||||
|
// but it has the notable advantage of making ESTree much easier to use as
|
||||||
|
// an end user.
|
||||||
|
|
||||||
|
export interface BaseNodeWithoutComments {
|
||||||
|
// Every leaf interface that extends BaseNode must specify a type property.
|
||||||
|
// The type property should be a string literal. For example, Identifier
|
||||||
|
// has: `type: "Identifier"`
|
||||||
|
type: string;
|
||||||
|
loc?: SourceLocation | null | undefined;
|
||||||
|
range?: [number, number] | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BaseNode extends BaseNodeWithoutComments {
|
||||||
|
leadingComments?: Comment[] | undefined;
|
||||||
|
trailingComments?: Comment[] | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface NodeMap {
|
||||||
|
AssignmentProperty: AssignmentProperty;
|
||||||
|
CatchClause: CatchClause;
|
||||||
|
Class: Class;
|
||||||
|
ClassBody: ClassBody;
|
||||||
|
Expression: Expression;
|
||||||
|
Function: Function;
|
||||||
|
Identifier: Identifier;
|
||||||
|
Literal: Literal;
|
||||||
|
MethodDefinition: MethodDefinition;
|
||||||
|
ModuleDeclaration: ModuleDeclaration;
|
||||||
|
ModuleSpecifier: ModuleSpecifier;
|
||||||
|
Pattern: Pattern;
|
||||||
|
PrivateIdentifier: PrivateIdentifier;
|
||||||
|
Program: Program;
|
||||||
|
Property: Property;
|
||||||
|
PropertyDefinition: PropertyDefinition;
|
||||||
|
SpreadElement: SpreadElement;
|
||||||
|
Statement: Statement;
|
||||||
|
Super: Super;
|
||||||
|
SwitchCase: SwitchCase;
|
||||||
|
TemplateElement: TemplateElement;
|
||||||
|
VariableDeclarator: VariableDeclarator;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Node = NodeMap[keyof NodeMap];
|
||||||
|
|
||||||
|
export interface Comment extends BaseNodeWithoutComments {
|
||||||
|
type: "Line" | "Block";
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SourceLocation {
|
||||||
|
source?: string | null | undefined;
|
||||||
|
start: Position;
|
||||||
|
end: Position;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Position {
|
||||||
|
/** >= 1 */
|
||||||
|
line: number;
|
||||||
|
/** >= 0 */
|
||||||
|
column: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Program extends BaseNode {
|
||||||
|
type: "Program";
|
||||||
|
sourceType: "script" | "module";
|
||||||
|
body: Array<Directive | Statement | ModuleDeclaration>;
|
||||||
|
comments?: Comment[] | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Directive extends BaseNode {
|
||||||
|
type: "ExpressionStatement";
|
||||||
|
expression: Literal;
|
||||||
|
directive: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BaseFunction extends BaseNode {
|
||||||
|
params: Pattern[];
|
||||||
|
generator?: boolean | undefined;
|
||||||
|
async?: boolean | undefined;
|
||||||
|
// The body is either BlockStatement or Expression because arrow functions
|
||||||
|
// can have a body that's either. FunctionDeclarations and
|
||||||
|
// FunctionExpressions have only BlockStatement bodies.
|
||||||
|
body: BlockStatement | Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Function = FunctionDeclaration | FunctionExpression | ArrowFunctionExpression;
|
||||||
|
|
||||||
|
export type Statement =
|
||||||
|
| ExpressionStatement
|
||||||
|
| BlockStatement
|
||||||
|
| StaticBlock
|
||||||
|
| EmptyStatement
|
||||||
|
| DebuggerStatement
|
||||||
|
| WithStatement
|
||||||
|
| ReturnStatement
|
||||||
|
| LabeledStatement
|
||||||
|
| BreakStatement
|
||||||
|
| ContinueStatement
|
||||||
|
| IfStatement
|
||||||
|
| SwitchStatement
|
||||||
|
| ThrowStatement
|
||||||
|
| TryStatement
|
||||||
|
| WhileStatement
|
||||||
|
| DoWhileStatement
|
||||||
|
| ForStatement
|
||||||
|
| ForInStatement
|
||||||
|
| ForOfStatement
|
||||||
|
| Declaration;
|
||||||
|
|
||||||
|
export interface BaseStatement extends BaseNode {}
|
||||||
|
|
||||||
|
export interface EmptyStatement extends BaseStatement {
|
||||||
|
type: "EmptyStatement";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BlockStatement extends BaseStatement {
|
||||||
|
type: "BlockStatement";
|
||||||
|
body: Statement[];
|
||||||
|
innerComments?: Comment[] | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StaticBlock extends Omit<BlockStatement, "type"> {
|
||||||
|
type: "StaticBlock";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ExpressionStatement extends BaseStatement {
|
||||||
|
type: "ExpressionStatement";
|
||||||
|
expression: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IfStatement extends BaseStatement {
|
||||||
|
type: "IfStatement";
|
||||||
|
test: Expression;
|
||||||
|
consequent: Statement;
|
||||||
|
alternate?: Statement | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LabeledStatement extends BaseStatement {
|
||||||
|
type: "LabeledStatement";
|
||||||
|
label: Identifier;
|
||||||
|
body: Statement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BreakStatement extends BaseStatement {
|
||||||
|
type: "BreakStatement";
|
||||||
|
label?: Identifier | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ContinueStatement extends BaseStatement {
|
||||||
|
type: "ContinueStatement";
|
||||||
|
label?: Identifier | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface WithStatement extends BaseStatement {
|
||||||
|
type: "WithStatement";
|
||||||
|
object: Expression;
|
||||||
|
body: Statement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SwitchStatement extends BaseStatement {
|
||||||
|
type: "SwitchStatement";
|
||||||
|
discriminant: Expression;
|
||||||
|
cases: SwitchCase[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ReturnStatement extends BaseStatement {
|
||||||
|
type: "ReturnStatement";
|
||||||
|
argument?: Expression | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ThrowStatement extends BaseStatement {
|
||||||
|
type: "ThrowStatement";
|
||||||
|
argument: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TryStatement extends BaseStatement {
|
||||||
|
type: "TryStatement";
|
||||||
|
block: BlockStatement;
|
||||||
|
handler?: CatchClause | null | undefined;
|
||||||
|
finalizer?: BlockStatement | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface WhileStatement extends BaseStatement {
|
||||||
|
type: "WhileStatement";
|
||||||
|
test: Expression;
|
||||||
|
body: Statement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DoWhileStatement extends BaseStatement {
|
||||||
|
type: "DoWhileStatement";
|
||||||
|
body: Statement;
|
||||||
|
test: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ForStatement extends BaseStatement {
|
||||||
|
type: "ForStatement";
|
||||||
|
init?: VariableDeclaration | Expression | null | undefined;
|
||||||
|
test?: Expression | null | undefined;
|
||||||
|
update?: Expression | null | undefined;
|
||||||
|
body: Statement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BaseForXStatement extends BaseStatement {
|
||||||
|
left: VariableDeclaration | Pattern;
|
||||||
|
right: Expression;
|
||||||
|
body: Statement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ForInStatement extends BaseForXStatement {
|
||||||
|
type: "ForInStatement";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DebuggerStatement extends BaseStatement {
|
||||||
|
type: "DebuggerStatement";
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Declaration = FunctionDeclaration | VariableDeclaration | ClassDeclaration;
|
||||||
|
|
||||||
|
export interface BaseDeclaration extends BaseStatement {}
|
||||||
|
|
||||||
|
export interface MaybeNamedFunctionDeclaration extends BaseFunction, BaseDeclaration {
|
||||||
|
type: "FunctionDeclaration";
|
||||||
|
/** It is null when a function declaration is a part of the `export default function` statement */
|
||||||
|
id: Identifier | null;
|
||||||
|
body: BlockStatement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FunctionDeclaration extends MaybeNamedFunctionDeclaration {
|
||||||
|
id: Identifier;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface VariableDeclaration extends BaseDeclaration {
|
||||||
|
type: "VariableDeclaration";
|
||||||
|
declarations: VariableDeclarator[];
|
||||||
|
kind: "var" | "let" | "const" | "using" | "await using";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface VariableDeclarator extends BaseNode {
|
||||||
|
type: "VariableDeclarator";
|
||||||
|
id: Pattern;
|
||||||
|
init?: Expression | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ExpressionMap {
|
||||||
|
ArrayExpression: ArrayExpression;
|
||||||
|
ArrowFunctionExpression: ArrowFunctionExpression;
|
||||||
|
AssignmentExpression: AssignmentExpression;
|
||||||
|
AwaitExpression: AwaitExpression;
|
||||||
|
BinaryExpression: BinaryExpression;
|
||||||
|
CallExpression: CallExpression;
|
||||||
|
ChainExpression: ChainExpression;
|
||||||
|
ClassExpression: ClassExpression;
|
||||||
|
ConditionalExpression: ConditionalExpression;
|
||||||
|
FunctionExpression: FunctionExpression;
|
||||||
|
Identifier: Identifier;
|
||||||
|
ImportExpression: ImportExpression;
|
||||||
|
Literal: Literal;
|
||||||
|
LogicalExpression: LogicalExpression;
|
||||||
|
MemberExpression: MemberExpression;
|
||||||
|
MetaProperty: MetaProperty;
|
||||||
|
NewExpression: NewExpression;
|
||||||
|
ObjectExpression: ObjectExpression;
|
||||||
|
SequenceExpression: SequenceExpression;
|
||||||
|
TaggedTemplateExpression: TaggedTemplateExpression;
|
||||||
|
TemplateLiteral: TemplateLiteral;
|
||||||
|
ThisExpression: ThisExpression;
|
||||||
|
UnaryExpression: UnaryExpression;
|
||||||
|
UpdateExpression: UpdateExpression;
|
||||||
|
YieldExpression: YieldExpression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Expression = ExpressionMap[keyof ExpressionMap];
|
||||||
|
|
||||||
|
export interface BaseExpression extends BaseNode {}
|
||||||
|
|
||||||
|
export type ChainElement = SimpleCallExpression | MemberExpression;
|
||||||
|
|
||||||
|
export interface ChainExpression extends BaseExpression {
|
||||||
|
type: "ChainExpression";
|
||||||
|
expression: ChainElement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ThisExpression extends BaseExpression {
|
||||||
|
type: "ThisExpression";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ArrayExpression extends BaseExpression {
|
||||||
|
type: "ArrayExpression";
|
||||||
|
elements: Array<Expression | SpreadElement | null>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ObjectExpression extends BaseExpression {
|
||||||
|
type: "ObjectExpression";
|
||||||
|
properties: Array<Property | SpreadElement>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PrivateIdentifier extends BaseNode {
|
||||||
|
type: "PrivateIdentifier";
|
||||||
|
name: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Property extends BaseNode {
|
||||||
|
type: "Property";
|
||||||
|
key: Expression | PrivateIdentifier;
|
||||||
|
value: Expression | Pattern; // Could be an AssignmentProperty
|
||||||
|
kind: "init" | "get" | "set";
|
||||||
|
method: boolean;
|
||||||
|
shorthand: boolean;
|
||||||
|
computed: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface PropertyDefinition extends BaseNode {
|
||||||
|
type: "PropertyDefinition";
|
||||||
|
key: Expression | PrivateIdentifier;
|
||||||
|
value?: Expression | null | undefined;
|
||||||
|
computed: boolean;
|
||||||
|
static: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FunctionExpression extends BaseFunction, BaseExpression {
|
||||||
|
id?: Identifier | null | undefined;
|
||||||
|
type: "FunctionExpression";
|
||||||
|
body: BlockStatement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SequenceExpression extends BaseExpression {
|
||||||
|
type: "SequenceExpression";
|
||||||
|
expressions: Expression[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface UnaryExpression extends BaseExpression {
|
||||||
|
type: "UnaryExpression";
|
||||||
|
operator: UnaryOperator;
|
||||||
|
prefix: true;
|
||||||
|
argument: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BinaryExpression extends BaseExpression {
|
||||||
|
type: "BinaryExpression";
|
||||||
|
operator: BinaryOperator;
|
||||||
|
left: Expression | PrivateIdentifier;
|
||||||
|
right: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AssignmentExpression extends BaseExpression {
|
||||||
|
type: "AssignmentExpression";
|
||||||
|
operator: AssignmentOperator;
|
||||||
|
left: Pattern | MemberExpression;
|
||||||
|
right: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface UpdateExpression extends BaseExpression {
|
||||||
|
type: "UpdateExpression";
|
||||||
|
operator: UpdateOperator;
|
||||||
|
argument: Expression;
|
||||||
|
prefix: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LogicalExpression extends BaseExpression {
|
||||||
|
type: "LogicalExpression";
|
||||||
|
operator: LogicalOperator;
|
||||||
|
left: Expression;
|
||||||
|
right: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ConditionalExpression extends BaseExpression {
|
||||||
|
type: "ConditionalExpression";
|
||||||
|
test: Expression;
|
||||||
|
alternate: Expression;
|
||||||
|
consequent: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BaseCallExpression extends BaseExpression {
|
||||||
|
callee: Expression | Super;
|
||||||
|
arguments: Array<Expression | SpreadElement>;
|
||||||
|
}
|
||||||
|
export type CallExpression = SimpleCallExpression | NewExpression;
|
||||||
|
|
||||||
|
export interface SimpleCallExpression extends BaseCallExpression {
|
||||||
|
type: "CallExpression";
|
||||||
|
optional: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface NewExpression extends BaseCallExpression {
|
||||||
|
type: "NewExpression";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MemberExpression extends BaseExpression, BasePattern {
|
||||||
|
type: "MemberExpression";
|
||||||
|
object: Expression | Super;
|
||||||
|
property: Expression | PrivateIdentifier;
|
||||||
|
computed: boolean;
|
||||||
|
optional: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Pattern = Identifier | ObjectPattern | ArrayPattern | RestElement | AssignmentPattern | MemberExpression;
|
||||||
|
|
||||||
|
export interface BasePattern extends BaseNode {}
|
||||||
|
|
||||||
|
export interface SwitchCase extends BaseNode {
|
||||||
|
type: "SwitchCase";
|
||||||
|
test?: Expression | null | undefined;
|
||||||
|
consequent: Statement[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CatchClause extends BaseNode {
|
||||||
|
type: "CatchClause";
|
||||||
|
param: Pattern | null;
|
||||||
|
body: BlockStatement;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Identifier extends BaseNode, BaseExpression, BasePattern {
|
||||||
|
type: "Identifier";
|
||||||
|
name: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Literal = SimpleLiteral | RegExpLiteral | BigIntLiteral;
|
||||||
|
|
||||||
|
export interface SimpleLiteral extends BaseNode, BaseExpression {
|
||||||
|
type: "Literal";
|
||||||
|
value: string | boolean | number | null;
|
||||||
|
raw?: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RegExpLiteral extends BaseNode, BaseExpression {
|
||||||
|
type: "Literal";
|
||||||
|
value?: RegExp | null | undefined;
|
||||||
|
regex: {
|
||||||
|
pattern: string;
|
||||||
|
flags: string;
|
||||||
|
};
|
||||||
|
raw?: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BigIntLiteral extends BaseNode, BaseExpression {
|
||||||
|
type: "Literal";
|
||||||
|
value?: bigint | null | undefined;
|
||||||
|
bigint: string;
|
||||||
|
raw?: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type UnaryOperator = "-" | "+" | "!" | "~" | "typeof" | "void" | "delete";
|
||||||
|
|
||||||
|
export type BinaryOperator =
|
||||||
|
| "=="
|
||||||
|
| "!="
|
||||||
|
| "==="
|
||||||
|
| "!=="
|
||||||
|
| "<"
|
||||||
|
| "<="
|
||||||
|
| ">"
|
||||||
|
| ">="
|
||||||
|
| "<<"
|
||||||
|
| ">>"
|
||||||
|
| ">>>"
|
||||||
|
| "+"
|
||||||
|
| "-"
|
||||||
|
| "*"
|
||||||
|
| "/"
|
||||||
|
| "%"
|
||||||
|
| "**"
|
||||||
|
| "|"
|
||||||
|
| "^"
|
||||||
|
| "&"
|
||||||
|
| "in"
|
||||||
|
| "instanceof";
|
||||||
|
|
||||||
|
export type LogicalOperator = "||" | "&&" | "??";
|
||||||
|
|
||||||
|
export type AssignmentOperator =
|
||||||
|
| "="
|
||||||
|
| "+="
|
||||||
|
| "-="
|
||||||
|
| "*="
|
||||||
|
| "/="
|
||||||
|
| "%="
|
||||||
|
| "**="
|
||||||
|
| "<<="
|
||||||
|
| ">>="
|
||||||
|
| ">>>="
|
||||||
|
| "|="
|
||||||
|
| "^="
|
||||||
|
| "&="
|
||||||
|
| "||="
|
||||||
|
| "&&="
|
||||||
|
| "??=";
|
||||||
|
|
||||||
|
export type UpdateOperator = "++" | "--";
|
||||||
|
|
||||||
|
export interface ForOfStatement extends BaseForXStatement {
|
||||||
|
type: "ForOfStatement";
|
||||||
|
await: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Super extends BaseNode {
|
||||||
|
type: "Super";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SpreadElement extends BaseNode {
|
||||||
|
type: "SpreadElement";
|
||||||
|
argument: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ArrowFunctionExpression extends BaseExpression, BaseFunction {
|
||||||
|
type: "ArrowFunctionExpression";
|
||||||
|
expression: boolean;
|
||||||
|
body: BlockStatement | Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface YieldExpression extends BaseExpression {
|
||||||
|
type: "YieldExpression";
|
||||||
|
argument?: Expression | null | undefined;
|
||||||
|
delegate: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TemplateLiteral extends BaseExpression {
|
||||||
|
type: "TemplateLiteral";
|
||||||
|
quasis: TemplateElement[];
|
||||||
|
expressions: Expression[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TaggedTemplateExpression extends BaseExpression {
|
||||||
|
type: "TaggedTemplateExpression";
|
||||||
|
tag: Expression;
|
||||||
|
quasi: TemplateLiteral;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TemplateElement extends BaseNode {
|
||||||
|
type: "TemplateElement";
|
||||||
|
tail: boolean;
|
||||||
|
value: {
|
||||||
|
/** It is null when the template literal is tagged and the text has an invalid escape (e.g. - tag`\unicode and \u{55}`) */
|
||||||
|
cooked?: string | null | undefined;
|
||||||
|
raw: string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AssignmentProperty extends Property {
|
||||||
|
value: Pattern;
|
||||||
|
kind: "init";
|
||||||
|
method: boolean; // false
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ObjectPattern extends BasePattern {
|
||||||
|
type: "ObjectPattern";
|
||||||
|
properties: Array<AssignmentProperty | RestElement>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ArrayPattern extends BasePattern {
|
||||||
|
type: "ArrayPattern";
|
||||||
|
elements: Array<Pattern | null>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RestElement extends BasePattern {
|
||||||
|
type: "RestElement";
|
||||||
|
argument: Pattern;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AssignmentPattern extends BasePattern {
|
||||||
|
type: "AssignmentPattern";
|
||||||
|
left: Pattern;
|
||||||
|
right: Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Class = ClassDeclaration | ClassExpression;
|
||||||
|
export interface BaseClass extends BaseNode {
|
||||||
|
superClass?: Expression | null | undefined;
|
||||||
|
body: ClassBody;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClassBody extends BaseNode {
|
||||||
|
type: "ClassBody";
|
||||||
|
body: Array<MethodDefinition | PropertyDefinition | StaticBlock>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MethodDefinition extends BaseNode {
|
||||||
|
type: "MethodDefinition";
|
||||||
|
key: Expression | PrivateIdentifier;
|
||||||
|
value: FunctionExpression;
|
||||||
|
kind: "constructor" | "method" | "get" | "set";
|
||||||
|
computed: boolean;
|
||||||
|
static: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MaybeNamedClassDeclaration extends BaseClass, BaseDeclaration {
|
||||||
|
type: "ClassDeclaration";
|
||||||
|
/** It is null when a class declaration is a part of the `export default class` statement */
|
||||||
|
id: Identifier | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClassDeclaration extends MaybeNamedClassDeclaration {
|
||||||
|
id: Identifier;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClassExpression extends BaseClass, BaseExpression {
|
||||||
|
type: "ClassExpression";
|
||||||
|
id?: Identifier | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface MetaProperty extends BaseExpression {
|
||||||
|
type: "MetaProperty";
|
||||||
|
meta: Identifier;
|
||||||
|
property: Identifier;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ModuleDeclaration =
|
||||||
|
| ImportDeclaration
|
||||||
|
| ExportNamedDeclaration
|
||||||
|
| ExportDefaultDeclaration
|
||||||
|
| ExportAllDeclaration;
|
||||||
|
export interface BaseModuleDeclaration extends BaseNode {}
|
||||||
|
|
||||||
|
export type ModuleSpecifier = ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier | ExportSpecifier;
|
||||||
|
export interface BaseModuleSpecifier extends BaseNode {
|
||||||
|
local: Identifier;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ImportDeclaration extends BaseModuleDeclaration {
|
||||||
|
type: "ImportDeclaration";
|
||||||
|
specifiers: Array<ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier>;
|
||||||
|
attributes: ImportAttribute[];
|
||||||
|
source: Literal;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ImportSpecifier extends BaseModuleSpecifier {
|
||||||
|
type: "ImportSpecifier";
|
||||||
|
imported: Identifier | Literal;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ImportAttribute extends BaseNode {
|
||||||
|
type: "ImportAttribute";
|
||||||
|
key: Identifier | Literal;
|
||||||
|
value: Literal;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ImportExpression extends BaseExpression {
|
||||||
|
type: "ImportExpression";
|
||||||
|
source: Expression;
|
||||||
|
options?: Expression | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ImportDefaultSpecifier extends BaseModuleSpecifier {
|
||||||
|
type: "ImportDefaultSpecifier";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ImportNamespaceSpecifier extends BaseModuleSpecifier {
|
||||||
|
type: "ImportNamespaceSpecifier";
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ExportNamedDeclaration extends BaseModuleDeclaration {
|
||||||
|
type: "ExportNamedDeclaration";
|
||||||
|
declaration?: Declaration | null | undefined;
|
||||||
|
specifiers: ExportSpecifier[];
|
||||||
|
attributes: ImportAttribute[];
|
||||||
|
source?: Literal | null | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ExportSpecifier extends Omit<BaseModuleSpecifier, "local"> {
|
||||||
|
type: "ExportSpecifier";
|
||||||
|
local: Identifier | Literal;
|
||||||
|
exported: Identifier | Literal;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ExportDefaultDeclaration extends BaseModuleDeclaration {
|
||||||
|
type: "ExportDefaultDeclaration";
|
||||||
|
declaration: MaybeNamedFunctionDeclaration | MaybeNamedClassDeclaration | Expression;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ExportAllDeclaration extends BaseModuleDeclaration {
|
||||||
|
type: "ExportAllDeclaration";
|
||||||
|
exported: Identifier | Literal | null;
|
||||||
|
attributes: ImportAttribute[];
|
||||||
|
source: Literal;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AwaitExpression extends BaseExpression {
|
||||||
|
type: "AwaitExpression";
|
||||||
|
argument: Expression;
|
||||||
|
}
|
||||||
+27
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"name": "@types/estree",
|
||||||
|
"version": "1.0.8",
|
||||||
|
"description": "TypeScript definitions for estree",
|
||||||
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/estree",
|
||||||
|
"license": "MIT",
|
||||||
|
"contributors": [
|
||||||
|
{
|
||||||
|
"name": "RReverser",
|
||||||
|
"githubUsername": "RReverser",
|
||||||
|
"url": "https://github.com/RReverser"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"main": "",
|
||||||
|
"types": "index.d.ts",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
|
||||||
|
"directory": "types/estree"
|
||||||
|
},
|
||||||
|
"scripts": {},
|
||||||
|
"dependencies": {},
|
||||||
|
"peerDependencies": {},
|
||||||
|
"typesPublisherContentHash": "7a167b6e4a4d9f6e9a2cb9fd3fc45c885f89cbdeb44b3e5961bb057a45c082fd",
|
||||||
|
"typeScriptVersion": "5.1",
|
||||||
|
"nonNpm": true
|
||||||
|
}
|
||||||
+21
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE
|
||||||
+15
@@ -0,0 +1,15 @@
|
|||||||
|
# Installation
|
||||||
|
> `npm install --save @types/json-schema`
|
||||||
|
|
||||||
|
# Summary
|
||||||
|
This package contains type definitions for json-schema (https://github.com/kriszyp/json-schema).
|
||||||
|
|
||||||
|
# Details
|
||||||
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-schema.
|
||||||
|
|
||||||
|
### Additional Details
|
||||||
|
* Last updated: Tue, 07 Nov 2023 03:09:37 GMT
|
||||||
|
* Dependencies: none
|
||||||
|
|
||||||
|
# Credits
|
||||||
|
These definitions were written by [Boris Cherny](https://github.com/bcherny), [Lucian Buzzo](https://github.com/lucianbuzzo), [Roland Groza](https://github.com/rolandjitsu), and [Jason Kwok](https://github.com/JasonHK).
|
||||||
+749
@@ -0,0 +1,749 @@
|
|||||||
|
// ==================================================================================================
|
||||||
|
// JSON Schema Draft 04
|
||||||
|
// ==================================================================================================
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
|
||||||
|
*/
|
||||||
|
export type JSONSchema4TypeName =
|
||||||
|
| "string" //
|
||||||
|
| "number"
|
||||||
|
| "integer"
|
||||||
|
| "boolean"
|
||||||
|
| "object"
|
||||||
|
| "array"
|
||||||
|
| "null"
|
||||||
|
| "any";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-04#section-3.5
|
||||||
|
*/
|
||||||
|
export type JSONSchema4Type =
|
||||||
|
| string //
|
||||||
|
| number
|
||||||
|
| boolean
|
||||||
|
| JSONSchema4Object
|
||||||
|
| JSONSchema4Array
|
||||||
|
| null;
|
||||||
|
|
||||||
|
// Workaround for infinite type recursion
|
||||||
|
export interface JSONSchema4Object {
|
||||||
|
[key: string]: JSONSchema4Type;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Workaround for infinite type recursion
|
||||||
|
// https://github.com/Microsoft/TypeScript/issues/3496#issuecomment-128553540
|
||||||
|
export interface JSONSchema4Array extends Array<JSONSchema4Type> {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Meta schema
|
||||||
|
*
|
||||||
|
* Recommended values:
|
||||||
|
* - 'http://json-schema.org/schema#'
|
||||||
|
* - 'http://json-schema.org/hyper-schema#'
|
||||||
|
* - 'http://json-schema.org/draft-04/schema#'
|
||||||
|
* - 'http://json-schema.org/draft-04/hyper-schema#'
|
||||||
|
* - 'http://json-schema.org/draft-03/schema#'
|
||||||
|
* - 'http://json-schema.org/draft-03/hyper-schema#'
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
|
||||||
|
*/
|
||||||
|
export type JSONSchema4Version = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* JSON Schema V4
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-04
|
||||||
|
*/
|
||||||
|
export interface JSONSchema4 {
|
||||||
|
id?: string | undefined;
|
||||||
|
$ref?: string | undefined;
|
||||||
|
$schema?: JSONSchema4Version | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute is a string that provides a short description of the
|
||||||
|
* instance property.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.21
|
||||||
|
*/
|
||||||
|
title?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute is a string that provides a full description of the of
|
||||||
|
* purpose the instance property.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.22
|
||||||
|
*/
|
||||||
|
description?: string | undefined;
|
||||||
|
|
||||||
|
default?: JSONSchema4Type | undefined;
|
||||||
|
multipleOf?: number | undefined;
|
||||||
|
maximum?: number | undefined;
|
||||||
|
exclusiveMaximum?: boolean | undefined;
|
||||||
|
minimum?: number | undefined;
|
||||||
|
exclusiveMinimum?: boolean | undefined;
|
||||||
|
maxLength?: number | undefined;
|
||||||
|
minLength?: number | undefined;
|
||||||
|
pattern?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* May only be defined when "items" is defined, and is a tuple of JSONSchemas.
|
||||||
|
*
|
||||||
|
* This provides a definition for additional items in an array instance
|
||||||
|
* when tuple definitions of the items is provided. This can be false
|
||||||
|
* to indicate additional items in the array are not allowed, or it can
|
||||||
|
* be a schema that defines the schema of the additional items.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6
|
||||||
|
*/
|
||||||
|
additionalItems?: boolean | JSONSchema4 | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute defines the allowed items in an instance array, and
|
||||||
|
* MUST be a schema or an array of schemas. The default value is an
|
||||||
|
* empty schema which allows any value for items in the instance array.
|
||||||
|
*
|
||||||
|
* When this attribute value is a schema and the instance value is an
|
||||||
|
* array, then all the items in the array MUST be valid according to the
|
||||||
|
* schema.
|
||||||
|
*
|
||||||
|
* When this attribute value is an array of schemas and the instance
|
||||||
|
* value is an array, each position in the instance array MUST conform
|
||||||
|
* to the schema in the corresponding position for this array. This
|
||||||
|
* called tuple typing. When tuple typing is used, additional items are
|
||||||
|
* allowed, disallowed, or constrained by the "additionalItems"
|
||||||
|
* (Section 5.6) attribute using the same rules as
|
||||||
|
* "additionalProperties" (Section 5.4) for objects.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.5
|
||||||
|
*/
|
||||||
|
items?: JSONSchema4 | JSONSchema4[] | undefined;
|
||||||
|
|
||||||
|
maxItems?: number | undefined;
|
||||||
|
minItems?: number | undefined;
|
||||||
|
uniqueItems?: boolean | undefined;
|
||||||
|
maxProperties?: number | undefined;
|
||||||
|
minProperties?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute indicates if the instance must have a value, and not
|
||||||
|
* be undefined. This is false by default, making the instance
|
||||||
|
* optional.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.7
|
||||||
|
*/
|
||||||
|
required?: boolean | string[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute defines a schema for all properties that are not
|
||||||
|
* explicitly defined in an object type definition. If specified, the
|
||||||
|
* value MUST be a schema or a boolean. If false is provided, no
|
||||||
|
* additional properties are allowed beyond the properties defined in
|
||||||
|
* the schema. The default value is an empty schema which allows any
|
||||||
|
* value for additional properties.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.4
|
||||||
|
*/
|
||||||
|
additionalProperties?: boolean | JSONSchema4 | undefined;
|
||||||
|
|
||||||
|
definitions?: {
|
||||||
|
[k: string]: JSONSchema4;
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute is an object with property definitions that define the
|
||||||
|
* valid values of instance object property values. When the instance
|
||||||
|
* value is an object, the property values of the instance object MUST
|
||||||
|
* conform to the property definitions in this object. In this object,
|
||||||
|
* each property definition's value MUST be a schema, and the property's
|
||||||
|
* name MUST be the name of the instance property that it defines. The
|
||||||
|
* instance property value MUST be valid according to the schema from
|
||||||
|
* the property definition. Properties are considered unordered, the
|
||||||
|
* order of the instance properties MAY be in any order.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.2
|
||||||
|
*/
|
||||||
|
properties?: {
|
||||||
|
[k: string]: JSONSchema4;
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute is an object that defines the schema for a set of
|
||||||
|
* property names of an object instance. The name of each property of
|
||||||
|
* this attribute's object is a regular expression pattern in the ECMA
|
||||||
|
* 262/Perl 5 format, while the value is a schema. If the pattern
|
||||||
|
* matches the name of a property on the instance object, the value of
|
||||||
|
* the instance's property MUST be valid against the pattern name's
|
||||||
|
* schema value.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.3
|
||||||
|
*/
|
||||||
|
patternProperties?: {
|
||||||
|
[k: string]: JSONSchema4;
|
||||||
|
} | undefined;
|
||||||
|
dependencies?: {
|
||||||
|
[k: string]: JSONSchema4 | string[];
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This provides an enumeration of all possible values that are valid
|
||||||
|
* for the instance property. This MUST be an array, and each item in
|
||||||
|
* the array represents a possible value for the instance value. If
|
||||||
|
* this attribute is defined, the instance value MUST be one of the
|
||||||
|
* values in the array in order for the schema to be valid.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.19
|
||||||
|
*/
|
||||||
|
enum?: JSONSchema4Type[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A single type, or a union of simple types
|
||||||
|
*/
|
||||||
|
type?: JSONSchema4TypeName | JSONSchema4TypeName[] | undefined;
|
||||||
|
|
||||||
|
allOf?: JSONSchema4[] | undefined;
|
||||||
|
anyOf?: JSONSchema4[] | undefined;
|
||||||
|
oneOf?: JSONSchema4[] | undefined;
|
||||||
|
not?: JSONSchema4 | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The value of this property MUST be another schema which will provide
|
||||||
|
* a base schema which the current schema will inherit from. The
|
||||||
|
* inheritance rules are such that any instance that is valid according
|
||||||
|
* to the current schema MUST be valid according to the referenced
|
||||||
|
* schema. This MAY also be an array, in which case, the instance MUST
|
||||||
|
* be valid for all the schemas in the array. A schema that extends
|
||||||
|
* another schema MAY define additional attributes, constrain existing
|
||||||
|
* attributes, or add other constraints.
|
||||||
|
*
|
||||||
|
* Conceptually, the behavior of extends can be seen as validating an
|
||||||
|
* instance against all constraints in the extending schema as well as
|
||||||
|
* the extended schema(s).
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.26
|
||||||
|
*/
|
||||||
|
extends?: string | string[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-zyp-json-schema-04#section-5.6
|
||||||
|
*/
|
||||||
|
[k: string]: any;
|
||||||
|
|
||||||
|
format?: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ==================================================================================================
|
||||||
|
// JSON Schema Draft 06
|
||||||
|
// ==================================================================================================
|
||||||
|
|
||||||
|
export type JSONSchema6TypeName =
|
||||||
|
| "string" //
|
||||||
|
| "number"
|
||||||
|
| "integer"
|
||||||
|
| "boolean"
|
||||||
|
| "object"
|
||||||
|
| "array"
|
||||||
|
| "null"
|
||||||
|
| "any";
|
||||||
|
|
||||||
|
export type JSONSchema6Type =
|
||||||
|
| string //
|
||||||
|
| number
|
||||||
|
| boolean
|
||||||
|
| JSONSchema6Object
|
||||||
|
| JSONSchema6Array
|
||||||
|
| null;
|
||||||
|
|
||||||
|
// Workaround for infinite type recursion
|
||||||
|
export interface JSONSchema6Object {
|
||||||
|
[key: string]: JSONSchema6Type;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Workaround for infinite type recursion
|
||||||
|
// https://github.com/Microsoft/TypeScript/issues/3496#issuecomment-128553540
|
||||||
|
export interface JSONSchema6Array extends Array<JSONSchema6Type> {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Meta schema
|
||||||
|
*
|
||||||
|
* Recommended values:
|
||||||
|
* - 'http://json-schema.org/schema#'
|
||||||
|
* - 'http://json-schema.org/hyper-schema#'
|
||||||
|
* - 'http://json-schema.org/draft-06/schema#'
|
||||||
|
* - 'http://json-schema.org/draft-06/hyper-schema#'
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
|
||||||
|
*/
|
||||||
|
export type JSONSchema6Version = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* JSON Schema V6
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01
|
||||||
|
*/
|
||||||
|
export type JSONSchema6Definition = JSONSchema6 | boolean;
|
||||||
|
export interface JSONSchema6 {
|
||||||
|
$id?: string | undefined;
|
||||||
|
$ref?: string | undefined;
|
||||||
|
$schema?: JSONSchema6Version | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Must be strictly greater than 0.
|
||||||
|
* A numeric instance is valid only if division by this keyword's value results in an integer.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.1
|
||||||
|
*/
|
||||||
|
multipleOf?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Representing an inclusive upper limit for a numeric instance.
|
||||||
|
* This keyword validates only if the instance is less than or exactly equal to "maximum".
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.2
|
||||||
|
*/
|
||||||
|
maximum?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Representing an exclusive upper limit for a numeric instance.
|
||||||
|
* This keyword validates only if the instance is strictly less than (not equal to) to "exclusiveMaximum".
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.3
|
||||||
|
*/
|
||||||
|
exclusiveMaximum?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Representing an inclusive lower limit for a numeric instance.
|
||||||
|
* This keyword validates only if the instance is greater than or exactly equal to "minimum".
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.4
|
||||||
|
*/
|
||||||
|
minimum?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Representing an exclusive lower limit for a numeric instance.
|
||||||
|
* This keyword validates only if the instance is strictly greater than (not equal to) to "exclusiveMinimum".
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.5
|
||||||
|
*/
|
||||||
|
exclusiveMinimum?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Must be a non-negative integer.
|
||||||
|
* A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.6
|
||||||
|
*/
|
||||||
|
maxLength?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Must be a non-negative integer.
|
||||||
|
* A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword.
|
||||||
|
* Omitting this keyword has the same behavior as a value of 0.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.7
|
||||||
|
*/
|
||||||
|
minLength?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Should be a valid regular expression, according to the ECMA 262 regular expression dialect.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.8
|
||||||
|
*/
|
||||||
|
pattern?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.
|
||||||
|
* Omitting this keyword has the same behavior as an empty schema.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.9
|
||||||
|
*/
|
||||||
|
items?: JSONSchema6Definition | JSONSchema6Definition[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This keyword determines how child instances validate for arrays, and does not directly validate the immediate instance itself.
|
||||||
|
* If "items" is an array of schemas, validation succeeds if every instance element
|
||||||
|
* at a position greater than the size of "items" validates against "additionalItems".
|
||||||
|
* Otherwise, "additionalItems" MUST be ignored, as the "items" schema
|
||||||
|
* (possibly the default value of an empty schema) is applied to all elements.
|
||||||
|
* Omitting this keyword has the same behavior as an empty schema.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.10
|
||||||
|
*/
|
||||||
|
additionalItems?: JSONSchema6Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Must be a non-negative integer.
|
||||||
|
* An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.11
|
||||||
|
*/
|
||||||
|
maxItems?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Must be a non-negative integer.
|
||||||
|
* An array instance is valid against "maxItems" if its size is greater than, or equal to, the value of this keyword.
|
||||||
|
* Omitting this keyword has the same behavior as a value of 0.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.12
|
||||||
|
*/
|
||||||
|
minItems?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If this keyword has boolean value false, the instance validates successfully.
|
||||||
|
* If it has boolean value true, the instance validates successfully if all of its elements are unique.
|
||||||
|
* Omitting this keyword has the same behavior as a value of false.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.13
|
||||||
|
*/
|
||||||
|
uniqueItems?: boolean | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An array instance is valid against "contains" if at least one of its elements is valid against the given schema.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.14
|
||||||
|
*/
|
||||||
|
contains?: JSONSchema6Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Must be a non-negative integer.
|
||||||
|
* An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.15
|
||||||
|
*/
|
||||||
|
maxProperties?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Must be a non-negative integer.
|
||||||
|
* An object instance is valid against "maxProperties" if its number of properties is greater than,
|
||||||
|
* or equal to, the value of this keyword.
|
||||||
|
* Omitting this keyword has the same behavior as a value of 0.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.16
|
||||||
|
*/
|
||||||
|
minProperties?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Elements of this array must be unique.
|
||||||
|
* An object instance is valid against this keyword if every item in the array is the name of a property in the instance.
|
||||||
|
* Omitting this keyword has the same behavior as an empty array.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.17
|
||||||
|
*/
|
||||||
|
required?: string[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This keyword determines how child instances validate for objects, and does not directly validate the immediate instance itself.
|
||||||
|
* Validation succeeds if, for each name that appears in both the instance and as a name within this keyword's value,
|
||||||
|
* the child instance for that name successfully validates against the corresponding schema.
|
||||||
|
* Omitting this keyword has the same behavior as an empty object.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.18
|
||||||
|
*/
|
||||||
|
properties?: {
|
||||||
|
[k: string]: JSONSchema6Definition;
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute is an object that defines the schema for a set of property names of an object instance.
|
||||||
|
* The name of each property of this attribute's object is a regular expression pattern in the ECMA 262, while the value is a schema.
|
||||||
|
* If the pattern matches the name of a property on the instance object, the value of the instance's property
|
||||||
|
* MUST be valid against the pattern name's schema value.
|
||||||
|
* Omitting this keyword has the same behavior as an empty object.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.19
|
||||||
|
*/
|
||||||
|
patternProperties?: {
|
||||||
|
[k: string]: JSONSchema6Definition;
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute defines a schema for all properties that are not explicitly defined in an object type definition.
|
||||||
|
* If specified, the value MUST be a schema or a boolean.
|
||||||
|
* If false is provided, no additional properties are allowed beyond the properties defined in the schema.
|
||||||
|
* The default value is an empty schema which allows any value for additional properties.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.20
|
||||||
|
*/
|
||||||
|
additionalProperties?: JSONSchema6Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This keyword specifies rules that are evaluated if the instance is an object and contains a certain property.
|
||||||
|
* Each property specifies a dependency.
|
||||||
|
* If the dependency value is an array, each element in the array must be unique.
|
||||||
|
* Omitting this keyword has the same behavior as an empty object.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.21
|
||||||
|
*/
|
||||||
|
dependencies?: {
|
||||||
|
[k: string]: JSONSchema6Definition | string[];
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Takes a schema which validates the names of all properties rather than their values.
|
||||||
|
* Note the property name that the schema is testing will always be a string.
|
||||||
|
* Omitting this keyword has the same behavior as an empty schema.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.22
|
||||||
|
*/
|
||||||
|
propertyNames?: JSONSchema6Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This provides an enumeration of all possible values that are valid
|
||||||
|
* for the instance property. This MUST be an array, and each item in
|
||||||
|
* the array represents a possible value for the instance value. If
|
||||||
|
* this attribute is defined, the instance value MUST be one of the
|
||||||
|
* values in the array in order for the schema to be valid.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.23
|
||||||
|
*/
|
||||||
|
enum?: JSONSchema6Type[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* More readable form of a one-element "enum"
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.24
|
||||||
|
*/
|
||||||
|
const?: JSONSchema6Type | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A single type, or a union of simple types
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.25
|
||||||
|
*/
|
||||||
|
type?: JSONSchema6TypeName | JSONSchema6TypeName[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
|
||||||
|
*/
|
||||||
|
allOf?: JSONSchema6Definition[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
|
||||||
|
*/
|
||||||
|
anyOf?: JSONSchema6Definition[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
|
||||||
|
*/
|
||||||
|
oneOf?: JSONSchema6Definition[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.29
|
||||||
|
*/
|
||||||
|
not?: JSONSchema6Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.1
|
||||||
|
*/
|
||||||
|
definitions?: {
|
||||||
|
[k: string]: JSONSchema6Definition;
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute is a string that provides a short description of the instance property.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.2
|
||||||
|
*/
|
||||||
|
title?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This attribute is a string that provides a full description of the of purpose the instance property.
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.2
|
||||||
|
*/
|
||||||
|
description?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This keyword can be used to supply a default JSON value associated with a particular schema.
|
||||||
|
* It is RECOMMENDED that a default value be valid against the associated schema.
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.3
|
||||||
|
*/
|
||||||
|
default?: JSONSchema6Type | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Array of examples with no validation effect the value of "default" is usable as an example without repeating it under this keyword
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-7.4
|
||||||
|
*/
|
||||||
|
examples?: JSONSchema6Type[] | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-8
|
||||||
|
*/
|
||||||
|
format?: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ==================================================================================================
|
||||||
|
// JSON Schema Draft 07
|
||||||
|
// ==================================================================================================
|
||||||
|
// https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
|
||||||
|
// --------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Primitive type
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
|
||||||
|
*/
|
||||||
|
export type JSONSchema7TypeName =
|
||||||
|
| "string" //
|
||||||
|
| "number"
|
||||||
|
| "integer"
|
||||||
|
| "boolean"
|
||||||
|
| "object"
|
||||||
|
| "array"
|
||||||
|
| "null";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Primitive type
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
|
||||||
|
*/
|
||||||
|
export type JSONSchema7Type =
|
||||||
|
| string //
|
||||||
|
| number
|
||||||
|
| boolean
|
||||||
|
| JSONSchema7Object
|
||||||
|
| JSONSchema7Array
|
||||||
|
| null;
|
||||||
|
|
||||||
|
// Workaround for infinite type recursion
|
||||||
|
export interface JSONSchema7Object {
|
||||||
|
[key: string]: JSONSchema7Type;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Workaround for infinite type recursion
|
||||||
|
// https://github.com/Microsoft/TypeScript/issues/3496#issuecomment-128553540
|
||||||
|
export interface JSONSchema7Array extends Array<JSONSchema7Type> {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Meta schema
|
||||||
|
*
|
||||||
|
* Recommended values:
|
||||||
|
* - 'http://json-schema.org/schema#'
|
||||||
|
* - 'http://json-schema.org/hyper-schema#'
|
||||||
|
* - 'http://json-schema.org/draft-07/schema#'
|
||||||
|
* - 'http://json-schema.org/draft-07/hyper-schema#'
|
||||||
|
*
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
|
||||||
|
*/
|
||||||
|
export type JSONSchema7Version = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* JSON Schema v7
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
|
||||||
|
*/
|
||||||
|
export type JSONSchema7Definition = JSONSchema7 | boolean;
|
||||||
|
export interface JSONSchema7 {
|
||||||
|
$id?: string | undefined;
|
||||||
|
$ref?: string | undefined;
|
||||||
|
$schema?: JSONSchema7Version | undefined;
|
||||||
|
$comment?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-8.2.4
|
||||||
|
* @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#appendix-A
|
||||||
|
*/
|
||||||
|
$defs?: {
|
||||||
|
[key: string]: JSONSchema7Definition;
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1
|
||||||
|
*/
|
||||||
|
type?: JSONSchema7TypeName | JSONSchema7TypeName[] | undefined;
|
||||||
|
enum?: JSONSchema7Type[] | undefined;
|
||||||
|
const?: JSONSchema7Type | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2
|
||||||
|
*/
|
||||||
|
multipleOf?: number | undefined;
|
||||||
|
maximum?: number | undefined;
|
||||||
|
exclusiveMaximum?: number | undefined;
|
||||||
|
minimum?: number | undefined;
|
||||||
|
exclusiveMinimum?: number | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3
|
||||||
|
*/
|
||||||
|
maxLength?: number | undefined;
|
||||||
|
minLength?: number | undefined;
|
||||||
|
pattern?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4
|
||||||
|
*/
|
||||||
|
items?: JSONSchema7Definition | JSONSchema7Definition[] | undefined;
|
||||||
|
additionalItems?: JSONSchema7Definition | undefined;
|
||||||
|
maxItems?: number | undefined;
|
||||||
|
minItems?: number | undefined;
|
||||||
|
uniqueItems?: boolean | undefined;
|
||||||
|
contains?: JSONSchema7Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5
|
||||||
|
*/
|
||||||
|
maxProperties?: number | undefined;
|
||||||
|
minProperties?: number | undefined;
|
||||||
|
required?: string[] | undefined;
|
||||||
|
properties?: {
|
||||||
|
[key: string]: JSONSchema7Definition;
|
||||||
|
} | undefined;
|
||||||
|
patternProperties?: {
|
||||||
|
[key: string]: JSONSchema7Definition;
|
||||||
|
} | undefined;
|
||||||
|
additionalProperties?: JSONSchema7Definition | undefined;
|
||||||
|
dependencies?: {
|
||||||
|
[key: string]: JSONSchema7Definition | string[];
|
||||||
|
} | undefined;
|
||||||
|
propertyNames?: JSONSchema7Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6
|
||||||
|
*/
|
||||||
|
if?: JSONSchema7Definition | undefined;
|
||||||
|
then?: JSONSchema7Definition | undefined;
|
||||||
|
else?: JSONSchema7Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7
|
||||||
|
*/
|
||||||
|
allOf?: JSONSchema7Definition[] | undefined;
|
||||||
|
anyOf?: JSONSchema7Definition[] | undefined;
|
||||||
|
oneOf?: JSONSchema7Definition[] | undefined;
|
||||||
|
not?: JSONSchema7Definition | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7
|
||||||
|
*/
|
||||||
|
format?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-8
|
||||||
|
*/
|
||||||
|
contentMediaType?: string | undefined;
|
||||||
|
contentEncoding?: string | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-9
|
||||||
|
*/
|
||||||
|
definitions?: {
|
||||||
|
[key: string]: JSONSchema7Definition;
|
||||||
|
} | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10
|
||||||
|
*/
|
||||||
|
title?: string | undefined;
|
||||||
|
description?: string | undefined;
|
||||||
|
default?: JSONSchema7Type | undefined;
|
||||||
|
readOnly?: boolean | undefined;
|
||||||
|
writeOnly?: boolean | undefined;
|
||||||
|
examples?: JSONSchema7Type | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ValidationResult {
|
||||||
|
valid: boolean;
|
||||||
|
errors: ValidationError[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ValidationError {
|
||||||
|
property: string;
|
||||||
|
message: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* To use the validator call JSONSchema.validate with an instance object and an optional schema object.
|
||||||
|
* If a schema is provided, it will be used to validate. If the instance object refers to a schema (self-validating),
|
||||||
|
* that schema will be used to validate and the schema parameter is not necessary (if both exist,
|
||||||
|
* both validations will occur).
|
||||||
|
*/
|
||||||
|
export function validate(instance: {}, schema: JSONSchema4 | JSONSchema6 | JSONSchema7): ValidationResult;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The checkPropertyChange method will check to see if an value can legally be in property with the given schema
|
||||||
|
* This is slightly different than the validate method in that it will fail if the schema is readonly and it will
|
||||||
|
* not check for self-validation, it is assumed that the passed in value is already internally valid.
|
||||||
|
*/
|
||||||
|
export function checkPropertyChange(
|
||||||
|
value: any,
|
||||||
|
schema: JSONSchema4 | JSONSchema6 | JSONSchema7,
|
||||||
|
property: string,
|
||||||
|
): ValidationResult;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This checks to ensure that the result is valid and will throw an appropriate error message if it is not.
|
||||||
|
*/
|
||||||
|
export function mustBeValid(result: ValidationResult): void;
|
||||||
+40
@@ -0,0 +1,40 @@
|
|||||||
|
{
|
||||||
|
"name": "@types/json-schema",
|
||||||
|
"version": "7.0.15",
|
||||||
|
"description": "TypeScript definitions for json-schema",
|
||||||
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-schema",
|
||||||
|
"license": "MIT",
|
||||||
|
"contributors": [
|
||||||
|
{
|
||||||
|
"name": "Boris Cherny",
|
||||||
|
"githubUsername": "bcherny",
|
||||||
|
"url": "https://github.com/bcherny"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Lucian Buzzo",
|
||||||
|
"githubUsername": "lucianbuzzo",
|
||||||
|
"url": "https://github.com/lucianbuzzo"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Roland Groza",
|
||||||
|
"githubUsername": "rolandjitsu",
|
||||||
|
"url": "https://github.com/rolandjitsu"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Jason Kwok",
|
||||||
|
"githubUsername": "JasonHK",
|
||||||
|
"url": "https://github.com/JasonHK"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"main": "",
|
||||||
|
"types": "index.d.ts",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
|
||||||
|
"directory": "types/json-schema"
|
||||||
|
},
|
||||||
|
"scripts": {},
|
||||||
|
"dependencies": {},
|
||||||
|
"typesPublisherContentHash": "79984fd70cd25c3f7d72b84368778c763c89728ea0073832d745d4691b705257",
|
||||||
|
"typeScriptVersion": "4.5"
|
||||||
|
}
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
# Installation
|
||||||
|
> `npm install --save @types/json5`
|
||||||
|
|
||||||
|
# Summary
|
||||||
|
This package contains type definitions for JSON5 (http://json5.org/).
|
||||||
|
|
||||||
|
# Details
|
||||||
|
Files were exported from https://www.github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/json5
|
||||||
|
|
||||||
|
Additional Details
|
||||||
|
* Last updated: Mon, 19 Sep 2016 17:28:59 GMT
|
||||||
|
* File structure: ProperModule
|
||||||
|
* Library Dependencies: none
|
||||||
|
* Module Dependencies: none
|
||||||
|
* Global values: json5
|
||||||
|
|
||||||
|
# Credits
|
||||||
|
These definitions were written by Jason Swearingen <https://jasonswearingen.github.io>.
|
||||||
+44
@@ -0,0 +1,44 @@
|
|||||||
|
// Type definitions for JSON5
|
||||||
|
// Project: http://json5.org/
|
||||||
|
// Definitions by: Jason Swearingen <https://jasonswearingen.github.io>
|
||||||
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||||
|
|
||||||
|
|
||||||
|
//commonjs loader
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The following is the exact list of additions to JSON's syntax introduced by JSON5. All of these are optional, and all of these come from ES5.
|
||||||
|
|
||||||
|
Objects
|
||||||
|
|
||||||
|
Object keys can be unquoted if they're valid identifiers. Yes, even reserved keywords (like default) are valid unquoted keys in ES5 [§11.1.5, §7.6]. (More info)
|
||||||
|
|
||||||
|
(TODO: Unicode characters and escape sequences aren’t yet supported in this implementation.)
|
||||||
|
|
||||||
|
Objects can have trailing commas.
|
||||||
|
|
||||||
|
Arrays
|
||||||
|
|
||||||
|
Arrays can have trailing commas.
|
||||||
|
Strings
|
||||||
|
|
||||||
|
Strings can be single-quoted.
|
||||||
|
|
||||||
|
Strings can be split across multiple lines; just prefix each newline with a backslash. [ES5 §7.8.4]
|
||||||
|
|
||||||
|
Numbers
|
||||||
|
|
||||||
|
Numbers can be hexadecimal (base 16).
|
||||||
|
|
||||||
|
Numbers can begin or end with a (leading or trailing) decimal point.
|
||||||
|
|
||||||
|
Numbers can include Infinity, -Infinity, NaN, and -NaN.
|
||||||
|
|
||||||
|
Numbers can begin with an explicit plus sign.
|
||||||
|
|
||||||
|
Comments
|
||||||
|
|
||||||
|
Both inline (single-line) and block (multi-line) comments are allowed.
|
||||||
|
*/
|
||||||
|
declare var json5: JSON;
|
||||||
|
export = json5;
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"name": "@types/json5",
|
||||||
|
"version": "0.0.29",
|
||||||
|
"description": "TypeScript definitions for JSON5",
|
||||||
|
"license": "MIT",
|
||||||
|
"author": "Jason Swearingen <https://jasonswearingen.github.io>",
|
||||||
|
"main": "",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://www.github.com/DefinitelyTyped/DefinitelyTyped.git"
|
||||||
|
},
|
||||||
|
"scripts": {},
|
||||||
|
"dependencies": {},
|
||||||
|
"typings": "index.d.ts",
|
||||||
|
"typesPublisherContentHash": "1ed77f2bfd59d290798abf89db281c36565f4a78d97d4e9caab25319d54c6331"
|
||||||
|
}
|
||||||
+25
@@ -0,0 +1,25 @@
|
|||||||
|
{
|
||||||
|
"authors": "Jason Swearingen <https://jasonswearingen.github.io>",
|
||||||
|
"definitionFilename": "index.d.ts",
|
||||||
|
"libraryDependencies": [],
|
||||||
|
"moduleDependencies": [],
|
||||||
|
"libraryMajorVersion": "0",
|
||||||
|
"libraryMinorVersion": "0",
|
||||||
|
"libraryName": "JSON5",
|
||||||
|
"typingsPackageName": "json5",
|
||||||
|
"projectName": "http://json5.org/",
|
||||||
|
"sourceRepoURL": "https://www.github.com/DefinitelyTyped/DefinitelyTyped",
|
||||||
|
"sourceBranch": "types-2.0",
|
||||||
|
"kind": "ProperModule",
|
||||||
|
"globals": [
|
||||||
|
"json5"
|
||||||
|
],
|
||||||
|
"declaredModules": [
|
||||||
|
"json5"
|
||||||
|
],
|
||||||
|
"files": [
|
||||||
|
"index.d.ts"
|
||||||
|
],
|
||||||
|
"hasPackageJson": false,
|
||||||
|
"contentHash": "1ed77f2bfd59d290798abf89db281c36565f4a78d97d4e9caab25319d54c6331"
|
||||||
|
}
|
||||||
+21
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE
|
||||||
+15
@@ -0,0 +1,15 @@
|
|||||||
|
# Installation
|
||||||
|
> `npm install --save @types/node`
|
||||||
|
|
||||||
|
# Summary
|
||||||
|
This package contains type definitions for node (https://nodejs.org/).
|
||||||
|
|
||||||
|
# Details
|
||||||
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node/v20.
|
||||||
|
|
||||||
|
### Additional Details
|
||||||
|
* Last updated: Fri, 06 Mar 2026 00:57:44 GMT
|
||||||
|
* Dependencies: [undici-types](https://npmjs.com/package/undici-types)
|
||||||
|
|
||||||
|
# Credits
|
||||||
|
These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [Alberto Schiabel](https://github.com/jkomyno), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [David Junger](https://github.com/touffy), [Mohsen Azimi](https://github.com/mohsen1), [Nikita Galkin](https://github.com/galkin), [Sebastian Silbermann](https://github.com/eps1lon), [Wilco Bakker](https://github.com/WilcoBakker), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), [ExE Boss](https://github.com/ExE-Boss), [Piotr Błażejewicz](https://github.com/peterblazejewicz), [Anna Henningsen](https://github.com/addaleax), [Victor Perin](https://github.com/victorperin), [NodeJS Contributors](https://github.com/NodeJS), [Linus Unnebäck](https://github.com/LinusU), [wafuwafu13](https://github.com/wafuwafu13), [Matteo Collina](https://github.com/mcollina), and [Dmitry Semigradsky](https://github.com/Semigradsky).
|
||||||
+1062
File diff suppressed because it is too large
Load Diff
+8
@@ -0,0 +1,8 @@
|
|||||||
|
declare module "assert/strict" {
|
||||||
|
import { strict } from "node:assert";
|
||||||
|
export = strict;
|
||||||
|
}
|
||||||
|
declare module "node:assert/strict" {
|
||||||
|
import { strict } from "node:assert";
|
||||||
|
export = strict;
|
||||||
|
}
|
||||||
+605
@@ -0,0 +1,605 @@
|
|||||||
|
/**
|
||||||
|
* We strongly discourage the use of the `async_hooks` API.
|
||||||
|
* Other APIs that can cover most of its use cases include:
|
||||||
|
*
|
||||||
|
* * [`AsyncLocalStorage`](https://nodejs.org/docs/latest-v20.x/api/async_context.html#class-asynclocalstorage) tracks async context
|
||||||
|
* * [`process.getActiveResourcesInfo()`](https://nodejs.org/docs/latest-v20.x/api/process.html#processgetactiveresourcesinfo) tracks active resources
|
||||||
|
*
|
||||||
|
* The `node:async_hooks` module provides an API to track asynchronous resources.
|
||||||
|
* It can be accessed using:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import async_hooks from 'node:async_hooks';
|
||||||
|
* ```
|
||||||
|
* @experimental
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/async_hooks.js)
|
||||||
|
*/
|
||||||
|
declare module "async_hooks" {
|
||||||
|
/**
|
||||||
|
* ```js
|
||||||
|
* import { executionAsyncId } from 'node:async_hooks';
|
||||||
|
* import fs from 'node:fs';
|
||||||
|
*
|
||||||
|
* console.log(executionAsyncId()); // 1 - bootstrap
|
||||||
|
* const path = '.';
|
||||||
|
* fs.open(path, 'r', (err, fd) => {
|
||||||
|
* console.log(executionAsyncId()); // 6 - open()
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The ID returned from `executionAsyncId()` is related to execution timing, not
|
||||||
|
* causality (which is covered by `triggerAsyncId()`):
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const server = net.createServer((conn) => {
|
||||||
|
* // Returns the ID of the server, not of the new connection, because the
|
||||||
|
* // callback runs in the execution scope of the server's MakeCallback().
|
||||||
|
* async_hooks.executionAsyncId();
|
||||||
|
*
|
||||||
|
* }).listen(port, () => {
|
||||||
|
* // Returns the ID of a TickObject (process.nextTick()) because all
|
||||||
|
* // callbacks passed to .listen() are wrapped in a nextTick().
|
||||||
|
* async_hooks.executionAsyncId();
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Promise contexts may not get precise `executionAsyncIds` by default.
|
||||||
|
* See the section on [promise execution tracking](https://nodejs.org/docs/latest-v20.x/api/async_hooks.html#promise-execution-tracking).
|
||||||
|
* @since v8.1.0
|
||||||
|
* @return The `asyncId` of the current execution context. Useful to track when something calls.
|
||||||
|
*/
|
||||||
|
function executionAsyncId(): number;
|
||||||
|
/**
|
||||||
|
* Resource objects returned by `executionAsyncResource()` are most often internal
|
||||||
|
* Node.js handle objects with undocumented APIs. Using any functions or properties
|
||||||
|
* on the object is likely to crash your application and should be avoided.
|
||||||
|
*
|
||||||
|
* Using `executionAsyncResource()` in the top-level execution context will
|
||||||
|
* return an empty object as there is no handle or request object to use,
|
||||||
|
* but having an object representing the top-level can be helpful.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { open } from 'node:fs';
|
||||||
|
* import { executionAsyncId, executionAsyncResource } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* console.log(executionAsyncId(), executionAsyncResource()); // 1 {}
|
||||||
|
* open(new URL(import.meta.url), 'r', (err, fd) => {
|
||||||
|
* console.log(executionAsyncId(), executionAsyncResource()); // 7 FSReqWrap
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* This can be used to implement continuation local storage without the
|
||||||
|
* use of a tracking `Map` to store the metadata:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { createServer } from 'node:http';
|
||||||
|
* import {
|
||||||
|
* executionAsyncId,
|
||||||
|
* executionAsyncResource,
|
||||||
|
* createHook,
|
||||||
|
* } from 'async_hooks';
|
||||||
|
* const sym = Symbol('state'); // Private symbol to avoid pollution
|
||||||
|
*
|
||||||
|
* createHook({
|
||||||
|
* init(asyncId, type, triggerAsyncId, resource) {
|
||||||
|
* const cr = executionAsyncResource();
|
||||||
|
* if (cr) {
|
||||||
|
* resource[sym] = cr[sym];
|
||||||
|
* }
|
||||||
|
* },
|
||||||
|
* }).enable();
|
||||||
|
*
|
||||||
|
* const server = createServer((req, res) => {
|
||||||
|
* executionAsyncResource()[sym] = { state: req.url };
|
||||||
|
* setTimeout(function() {
|
||||||
|
* res.end(JSON.stringify(executionAsyncResource()[sym]));
|
||||||
|
* }, 100);
|
||||||
|
* }).listen(3000);
|
||||||
|
* ```
|
||||||
|
* @since v13.9.0, v12.17.0
|
||||||
|
* @return The resource representing the current execution. Useful to store data within the resource.
|
||||||
|
*/
|
||||||
|
function executionAsyncResource(): object;
|
||||||
|
/**
|
||||||
|
* ```js
|
||||||
|
* const server = net.createServer((conn) => {
|
||||||
|
* // The resource that caused (or triggered) this callback to be called
|
||||||
|
* // was that of the new connection. Thus the return value of triggerAsyncId()
|
||||||
|
* // is the asyncId of "conn".
|
||||||
|
* async_hooks.triggerAsyncId();
|
||||||
|
*
|
||||||
|
* }).listen(port, () => {
|
||||||
|
* // Even though all callbacks passed to .listen() are wrapped in a nextTick()
|
||||||
|
* // the callback itself exists because the call to the server's .listen()
|
||||||
|
* // was made. So the return value would be the ID of the server.
|
||||||
|
* async_hooks.triggerAsyncId();
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Promise contexts may not get valid `triggerAsyncId`s by default. See
|
||||||
|
* the section on [promise execution tracking](https://nodejs.org/docs/latest-v20.x/api/async_hooks.html#promise-execution-tracking).
|
||||||
|
* @return The ID of the resource responsible for calling the callback that is currently being executed.
|
||||||
|
*/
|
||||||
|
function triggerAsyncId(): number;
|
||||||
|
interface HookCallbacks {
|
||||||
|
/**
|
||||||
|
* Called when a class is constructed that has the possibility to emit an asynchronous event.
|
||||||
|
* @param asyncId A unique ID for the async resource
|
||||||
|
* @param type The type of the async resource
|
||||||
|
* @param triggerAsyncId The unique ID of the async resource in whose execution context this async resource was created
|
||||||
|
* @param resource Reference to the resource representing the async operation, needs to be released during destroy
|
||||||
|
*/
|
||||||
|
init?(asyncId: number, type: string, triggerAsyncId: number, resource: object): void;
|
||||||
|
/**
|
||||||
|
* When an asynchronous operation is initiated or completes a callback is called to notify the user.
|
||||||
|
* The before callback is called just before said callback is executed.
|
||||||
|
* @param asyncId the unique identifier assigned to the resource about to execute the callback.
|
||||||
|
*/
|
||||||
|
before?(asyncId: number): void;
|
||||||
|
/**
|
||||||
|
* Called immediately after the callback specified in `before` is completed.
|
||||||
|
*
|
||||||
|
* If an uncaught exception occurs during execution of the callback, then `after` will run after the `'uncaughtException'` event is emitted or a `domain`'s handler runs.
|
||||||
|
* @param asyncId the unique identifier assigned to the resource which has executed the callback.
|
||||||
|
*/
|
||||||
|
after?(asyncId: number): void;
|
||||||
|
/**
|
||||||
|
* Called when a promise has resolve() called. This may not be in the same execution id
|
||||||
|
* as the promise itself.
|
||||||
|
* @param asyncId the unique id for the promise that was resolve()d.
|
||||||
|
*/
|
||||||
|
promiseResolve?(asyncId: number): void;
|
||||||
|
/**
|
||||||
|
* Called after the resource corresponding to asyncId is destroyed
|
||||||
|
* @param asyncId a unique ID for the async resource
|
||||||
|
*/
|
||||||
|
destroy?(asyncId: number): void;
|
||||||
|
}
|
||||||
|
interface AsyncHook {
|
||||||
|
/**
|
||||||
|
* Enable the callbacks for a given AsyncHook instance. If no callbacks are provided enabling is a noop.
|
||||||
|
*/
|
||||||
|
enable(): this;
|
||||||
|
/**
|
||||||
|
* Disable the callbacks for a given AsyncHook instance from the global pool of AsyncHook callbacks to be executed. Once a hook has been disabled it will not be called again until enabled.
|
||||||
|
*/
|
||||||
|
disable(): this;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Registers functions to be called for different lifetime events of each async
|
||||||
|
* operation.
|
||||||
|
*
|
||||||
|
* The callbacks `init()`/`before()`/`after()`/`destroy()` are called for the
|
||||||
|
* respective asynchronous event during a resource's lifetime.
|
||||||
|
*
|
||||||
|
* All callbacks are optional. For example, if only resource cleanup needs to
|
||||||
|
* be tracked, then only the `destroy` callback needs to be passed. The
|
||||||
|
* specifics of all functions that can be passed to `callbacks` is in the `Hook Callbacks` section.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { createHook } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* const asyncHook = createHook({
|
||||||
|
* init(asyncId, type, triggerAsyncId, resource) { },
|
||||||
|
* destroy(asyncId) { },
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The callbacks will be inherited via the prototype chain:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* class MyAsyncCallbacks {
|
||||||
|
* init(asyncId, type, triggerAsyncId, resource) { }
|
||||||
|
* destroy(asyncId) {}
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* class MyAddedCallbacks extends MyAsyncCallbacks {
|
||||||
|
* before(asyncId) { }
|
||||||
|
* after(asyncId) { }
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* const asyncHook = async_hooks.createHook(new MyAddedCallbacks());
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Because promises are asynchronous resources whose lifecycle is tracked
|
||||||
|
* via the async hooks mechanism, the `init()`, `before()`, `after()`, and`destroy()` callbacks _must not_ be async functions that return promises.
|
||||||
|
* @since v8.1.0
|
||||||
|
* @param callbacks The `Hook Callbacks` to register
|
||||||
|
* @return Instance used for disabling and enabling hooks
|
||||||
|
*/
|
||||||
|
function createHook(callbacks: HookCallbacks): AsyncHook;
|
||||||
|
interface AsyncResourceOptions {
|
||||||
|
/**
|
||||||
|
* The ID of the execution context that created this async event.
|
||||||
|
* @default executionAsyncId()
|
||||||
|
*/
|
||||||
|
triggerAsyncId?: number | undefined;
|
||||||
|
/**
|
||||||
|
* Disables automatic `emitDestroy` when the object is garbage collected.
|
||||||
|
* This usually does not need to be set (even if `emitDestroy` is called
|
||||||
|
* manually), unless the resource's `asyncId` is retrieved and the
|
||||||
|
* sensitive API's `emitDestroy` is called with it.
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
requireManualDestroy?: boolean | undefined;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The class `AsyncResource` is designed to be extended by the embedder's async
|
||||||
|
* resources. Using this, users can easily trigger the lifetime events of their
|
||||||
|
* own resources.
|
||||||
|
*
|
||||||
|
* The `init` hook will trigger when an `AsyncResource` is instantiated.
|
||||||
|
*
|
||||||
|
* The following is an overview of the `AsyncResource` API.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { AsyncResource, executionAsyncId } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* // AsyncResource() is meant to be extended. Instantiating a
|
||||||
|
* // new AsyncResource() also triggers init. If triggerAsyncId is omitted then
|
||||||
|
* // async_hook.executionAsyncId() is used.
|
||||||
|
* const asyncResource = new AsyncResource(
|
||||||
|
* type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false },
|
||||||
|
* );
|
||||||
|
*
|
||||||
|
* // Run a function in the execution context of the resource. This will
|
||||||
|
* // * establish the context of the resource
|
||||||
|
* // * trigger the AsyncHooks before callbacks
|
||||||
|
* // * call the provided function `fn` with the supplied arguments
|
||||||
|
* // * trigger the AsyncHooks after callbacks
|
||||||
|
* // * restore the original execution context
|
||||||
|
* asyncResource.runInAsyncScope(fn, thisArg, ...args);
|
||||||
|
*
|
||||||
|
* // Call AsyncHooks destroy callbacks.
|
||||||
|
* asyncResource.emitDestroy();
|
||||||
|
*
|
||||||
|
* // Return the unique ID assigned to the AsyncResource instance.
|
||||||
|
* asyncResource.asyncId();
|
||||||
|
*
|
||||||
|
* // Return the trigger ID for the AsyncResource instance.
|
||||||
|
* asyncResource.triggerAsyncId();
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
class AsyncResource {
|
||||||
|
/**
|
||||||
|
* AsyncResource() is meant to be extended. Instantiating a
|
||||||
|
* new AsyncResource() also triggers init. If triggerAsyncId is omitted then
|
||||||
|
* async_hook.executionAsyncId() is used.
|
||||||
|
* @param type The type of async event.
|
||||||
|
* @param triggerAsyncId The ID of the execution context that created
|
||||||
|
* this async event (default: `executionAsyncId()`), or an
|
||||||
|
* AsyncResourceOptions object (since v9.3.0)
|
||||||
|
*/
|
||||||
|
constructor(type: string, triggerAsyncId?: number | AsyncResourceOptions);
|
||||||
|
/**
|
||||||
|
* Binds the given function to the current execution context.
|
||||||
|
* @since v14.8.0, v12.19.0
|
||||||
|
* @param fn The function to bind to the current execution context.
|
||||||
|
* @param type An optional name to associate with the underlying `AsyncResource`.
|
||||||
|
*/
|
||||||
|
static bind<Func extends (this: ThisArg, ...args: any[]) => any, ThisArg>(
|
||||||
|
fn: Func,
|
||||||
|
type?: string,
|
||||||
|
thisArg?: ThisArg,
|
||||||
|
): Func;
|
||||||
|
/**
|
||||||
|
* Binds the given function to execute to this `AsyncResource`'s scope.
|
||||||
|
* @since v14.8.0, v12.19.0
|
||||||
|
* @param fn The function to bind to the current `AsyncResource`.
|
||||||
|
*/
|
||||||
|
bind<Func extends (...args: any[]) => any>(fn: Func): Func;
|
||||||
|
/**
|
||||||
|
* Call the provided function with the provided arguments in the execution context
|
||||||
|
* of the async resource. This will establish the context, trigger the AsyncHooks
|
||||||
|
* before callbacks, call the function, trigger the AsyncHooks after callbacks, and
|
||||||
|
* then restore the original execution context.
|
||||||
|
* @since v9.6.0
|
||||||
|
* @param fn The function to call in the execution context of this async resource.
|
||||||
|
* @param thisArg The receiver to be used for the function call.
|
||||||
|
* @param args Optional arguments to pass to the function.
|
||||||
|
*/
|
||||||
|
runInAsyncScope<This, Result>(
|
||||||
|
fn: (this: This, ...args: any[]) => Result,
|
||||||
|
thisArg?: This,
|
||||||
|
...args: any[]
|
||||||
|
): Result;
|
||||||
|
/**
|
||||||
|
* Call all `destroy` hooks. This should only ever be called once. An error will
|
||||||
|
* be thrown if it is called more than once. This **must** be manually called. If
|
||||||
|
* the resource is left to be collected by the GC then the `destroy` hooks will
|
||||||
|
* never be called.
|
||||||
|
* @return A reference to `asyncResource`.
|
||||||
|
*/
|
||||||
|
emitDestroy(): this;
|
||||||
|
/**
|
||||||
|
* @return The unique `asyncId` assigned to the resource.
|
||||||
|
*/
|
||||||
|
asyncId(): number;
|
||||||
|
/**
|
||||||
|
* @return The same `triggerAsyncId` that is passed to the `AsyncResource` constructor.
|
||||||
|
*/
|
||||||
|
triggerAsyncId(): number;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* This class creates stores that stay coherent through asynchronous operations.
|
||||||
|
*
|
||||||
|
* While you can create your own implementation on top of the `node:async_hooks` module, `AsyncLocalStorage` should be preferred as it is a performant and memory
|
||||||
|
* safe implementation that involves significant optimizations that are non-obvious
|
||||||
|
* to implement.
|
||||||
|
*
|
||||||
|
* The following example uses `AsyncLocalStorage` to build a simple logger
|
||||||
|
* that assigns IDs to incoming HTTP requests and includes them in messages
|
||||||
|
* logged within each request.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import http from 'node:http';
|
||||||
|
* import { AsyncLocalStorage } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* const asyncLocalStorage = new AsyncLocalStorage();
|
||||||
|
*
|
||||||
|
* function logWithId(msg) {
|
||||||
|
* const id = asyncLocalStorage.getStore();
|
||||||
|
* console.log(`${id !== undefined ? id : '-'}:`, msg);
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* let idSeq = 0;
|
||||||
|
* http.createServer((req, res) => {
|
||||||
|
* asyncLocalStorage.run(idSeq++, () => {
|
||||||
|
* logWithId('start');
|
||||||
|
* // Imagine any chain of async operations here
|
||||||
|
* setImmediate(() => {
|
||||||
|
* logWithId('finish');
|
||||||
|
* res.end();
|
||||||
|
* });
|
||||||
|
* });
|
||||||
|
* }).listen(8080);
|
||||||
|
*
|
||||||
|
* http.get('http://localhost:8080');
|
||||||
|
* http.get('http://localhost:8080');
|
||||||
|
* // Prints:
|
||||||
|
* // 0: start
|
||||||
|
* // 1: start
|
||||||
|
* // 0: finish
|
||||||
|
* // 1: finish
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Each instance of `AsyncLocalStorage` maintains an independent storage context.
|
||||||
|
* Multiple instances can safely exist simultaneously without risk of interfering
|
||||||
|
* with each other's data.
|
||||||
|
* @since v13.10.0, v12.17.0
|
||||||
|
*/
|
||||||
|
class AsyncLocalStorage<T> {
|
||||||
|
/**
|
||||||
|
* Binds the given function to the current execution context.
|
||||||
|
* @since v19.8.0
|
||||||
|
* @experimental
|
||||||
|
* @param fn The function to bind to the current execution context.
|
||||||
|
* @return A new function that calls `fn` within the captured execution context.
|
||||||
|
*/
|
||||||
|
static bind<Func extends (...args: any[]) => any>(fn: Func): Func;
|
||||||
|
/**
|
||||||
|
* Captures the current execution context and returns a function that accepts a
|
||||||
|
* function as an argument. Whenever the returned function is called, it
|
||||||
|
* calls the function passed to it within the captured context.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const asyncLocalStorage = new AsyncLocalStorage();
|
||||||
|
* const runInAsyncScope = asyncLocalStorage.run(123, () => AsyncLocalStorage.snapshot());
|
||||||
|
* const result = asyncLocalStorage.run(321, () => runInAsyncScope(() => asyncLocalStorage.getStore()));
|
||||||
|
* console.log(result); // returns 123
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* AsyncLocalStorage.snapshot() can replace the use of AsyncResource for simple
|
||||||
|
* async context tracking purposes, for example:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* class Foo {
|
||||||
|
* #runInAsyncScope = AsyncLocalStorage.snapshot();
|
||||||
|
*
|
||||||
|
* get() { return this.#runInAsyncScope(() => asyncLocalStorage.getStore()); }
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* const foo = asyncLocalStorage.run(123, () => new Foo());
|
||||||
|
* console.log(asyncLocalStorage.run(321, () => foo.get())); // returns 123
|
||||||
|
* ```
|
||||||
|
* @since v19.8.0
|
||||||
|
* @experimental
|
||||||
|
* @return A new function with the signature `(fn: (...args) : R, ...args) : R`.
|
||||||
|
*/
|
||||||
|
static snapshot(): <R, TArgs extends any[]>(fn: (...args: TArgs) => R, ...args: TArgs) => R;
|
||||||
|
/**
|
||||||
|
* Disables the instance of `AsyncLocalStorage`. All subsequent calls
|
||||||
|
* to `asyncLocalStorage.getStore()` will return `undefined` until `asyncLocalStorage.run()` or `asyncLocalStorage.enterWith()` is called again.
|
||||||
|
*
|
||||||
|
* When calling `asyncLocalStorage.disable()`, all current contexts linked to the
|
||||||
|
* instance will be exited.
|
||||||
|
*
|
||||||
|
* Calling `asyncLocalStorage.disable()` is required before the `asyncLocalStorage` can be garbage collected. This does not apply to stores
|
||||||
|
* provided by the `asyncLocalStorage`, as those objects are garbage collected
|
||||||
|
* along with the corresponding async resources.
|
||||||
|
*
|
||||||
|
* Use this method when the `asyncLocalStorage` is not in use anymore
|
||||||
|
* in the current process.
|
||||||
|
* @since v13.10.0, v12.17.0
|
||||||
|
* @experimental
|
||||||
|
*/
|
||||||
|
disable(): void;
|
||||||
|
/**
|
||||||
|
* Returns the current store.
|
||||||
|
* If called outside of an asynchronous context initialized by
|
||||||
|
* calling `asyncLocalStorage.run()` or `asyncLocalStorage.enterWith()`, it
|
||||||
|
* returns `undefined`.
|
||||||
|
* @since v13.10.0, v12.17.0
|
||||||
|
*/
|
||||||
|
getStore(): T | undefined;
|
||||||
|
/**
|
||||||
|
* Runs a function synchronously within a context and returns its
|
||||||
|
* return value. The store is not accessible outside of the callback function.
|
||||||
|
* The store is accessible to any asynchronous operations created within the
|
||||||
|
* callback.
|
||||||
|
*
|
||||||
|
* The optional `args` are passed to the callback function.
|
||||||
|
*
|
||||||
|
* If the callback function throws an error, the error is thrown by `run()` too.
|
||||||
|
* The stacktrace is not impacted by this call and the context is exited.
|
||||||
|
*
|
||||||
|
* Example:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const store = { id: 2 };
|
||||||
|
* try {
|
||||||
|
* asyncLocalStorage.run(store, () => {
|
||||||
|
* asyncLocalStorage.getStore(); // Returns the store object
|
||||||
|
* setTimeout(() => {
|
||||||
|
* asyncLocalStorage.getStore(); // Returns the store object
|
||||||
|
* }, 200);
|
||||||
|
* throw new Error();
|
||||||
|
* });
|
||||||
|
* } catch (e) {
|
||||||
|
* asyncLocalStorage.getStore(); // Returns undefined
|
||||||
|
* // The error will be caught here
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v13.10.0, v12.17.0
|
||||||
|
*/
|
||||||
|
run<R>(store: T, callback: () => R): R;
|
||||||
|
run<R, TArgs extends any[]>(store: T, callback: (...args: TArgs) => R, ...args: TArgs): R;
|
||||||
|
/**
|
||||||
|
* Runs a function synchronously outside of a context and returns its
|
||||||
|
* return value. The store is not accessible within the callback function or
|
||||||
|
* the asynchronous operations created within the callback. Any `getStore()` call done within the callback function will always return `undefined`.
|
||||||
|
*
|
||||||
|
* The optional `args` are passed to the callback function.
|
||||||
|
*
|
||||||
|
* If the callback function throws an error, the error is thrown by `exit()` too.
|
||||||
|
* The stacktrace is not impacted by this call and the context is re-entered.
|
||||||
|
*
|
||||||
|
* Example:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* // Within a call to run
|
||||||
|
* try {
|
||||||
|
* asyncLocalStorage.getStore(); // Returns the store object or value
|
||||||
|
* asyncLocalStorage.exit(() => {
|
||||||
|
* asyncLocalStorage.getStore(); // Returns undefined
|
||||||
|
* throw new Error();
|
||||||
|
* });
|
||||||
|
* } catch (e) {
|
||||||
|
* asyncLocalStorage.getStore(); // Returns the same object or value
|
||||||
|
* // The error will be caught here
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v13.10.0, v12.17.0
|
||||||
|
* @experimental
|
||||||
|
*/
|
||||||
|
exit<R, TArgs extends any[]>(callback: (...args: TArgs) => R, ...args: TArgs): R;
|
||||||
|
/**
|
||||||
|
* Transitions into the context for the remainder of the current
|
||||||
|
* synchronous execution and then persists the store through any following
|
||||||
|
* asynchronous calls.
|
||||||
|
*
|
||||||
|
* Example:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const store = { id: 1 };
|
||||||
|
* // Replaces previous store with the given store object
|
||||||
|
* asyncLocalStorage.enterWith(store);
|
||||||
|
* asyncLocalStorage.getStore(); // Returns the store object
|
||||||
|
* someAsyncOperation(() => {
|
||||||
|
* asyncLocalStorage.getStore(); // Returns the same object
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* This transition will continue for the _entire_ synchronous execution.
|
||||||
|
* This means that if, for example, the context is entered within an event
|
||||||
|
* handler subsequent event handlers will also run within that context unless
|
||||||
|
* specifically bound to another context with an `AsyncResource`. That is why `run()` should be preferred over `enterWith()` unless there are strong reasons
|
||||||
|
* to use the latter method.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const store = { id: 1 };
|
||||||
|
*
|
||||||
|
* emitter.on('my-event', () => {
|
||||||
|
* asyncLocalStorage.enterWith(store);
|
||||||
|
* });
|
||||||
|
* emitter.on('my-event', () => {
|
||||||
|
* asyncLocalStorage.getStore(); // Returns the same object
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* asyncLocalStorage.getStore(); // Returns undefined
|
||||||
|
* emitter.emit('my-event');
|
||||||
|
* asyncLocalStorage.getStore(); // Returns the same object
|
||||||
|
* ```
|
||||||
|
* @since v13.11.0, v12.17.0
|
||||||
|
* @experimental
|
||||||
|
*/
|
||||||
|
enterWith(store: T): void;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* @since v17.2.0, v16.14.0
|
||||||
|
* @return A map of provider types to the corresponding numeric id.
|
||||||
|
* This map contains all the event types that might be emitted by the `async_hooks.init()` event.
|
||||||
|
*/
|
||||||
|
namespace asyncWrapProviders {
|
||||||
|
const NONE: number;
|
||||||
|
const DIRHANDLE: number;
|
||||||
|
const DNSCHANNEL: number;
|
||||||
|
const ELDHISTOGRAM: number;
|
||||||
|
const FILEHANDLE: number;
|
||||||
|
const FILEHANDLECLOSEREQ: number;
|
||||||
|
const FIXEDSIZEBLOBCOPY: number;
|
||||||
|
const FSEVENTWRAP: number;
|
||||||
|
const FSREQCALLBACK: number;
|
||||||
|
const FSREQPROMISE: number;
|
||||||
|
const GETADDRINFOREQWRAP: number;
|
||||||
|
const GETNAMEINFOREQWRAP: number;
|
||||||
|
const HEAPSNAPSHOT: number;
|
||||||
|
const HTTP2SESSION: number;
|
||||||
|
const HTTP2STREAM: number;
|
||||||
|
const HTTP2PING: number;
|
||||||
|
const HTTP2SETTINGS: number;
|
||||||
|
const HTTPINCOMINGMESSAGE: number;
|
||||||
|
const HTTPCLIENTREQUEST: number;
|
||||||
|
const JSSTREAM: number;
|
||||||
|
const JSUDPWRAP: number;
|
||||||
|
const MESSAGEPORT: number;
|
||||||
|
const PIPECONNECTWRAP: number;
|
||||||
|
const PIPESERVERWRAP: number;
|
||||||
|
const PIPEWRAP: number;
|
||||||
|
const PROCESSWRAP: number;
|
||||||
|
const PROMISE: number;
|
||||||
|
const QUERYWRAP: number;
|
||||||
|
const SHUTDOWNWRAP: number;
|
||||||
|
const SIGNALWRAP: number;
|
||||||
|
const STATWATCHER: number;
|
||||||
|
const STREAMPIPE: number;
|
||||||
|
const TCPCONNECTWRAP: number;
|
||||||
|
const TCPSERVERWRAP: number;
|
||||||
|
const TCPWRAP: number;
|
||||||
|
const TTYWRAP: number;
|
||||||
|
const UDPSENDWRAP: number;
|
||||||
|
const UDPWRAP: number;
|
||||||
|
const SIGINTWATCHDOG: number;
|
||||||
|
const WORKER: number;
|
||||||
|
const WORKERHEAPSNAPSHOT: number;
|
||||||
|
const WRITEWRAP: number;
|
||||||
|
const ZLIB: number;
|
||||||
|
const CHECKPRIMEREQUEST: number;
|
||||||
|
const PBKDF2REQUEST: number;
|
||||||
|
const KEYPAIRGENREQUEST: number;
|
||||||
|
const KEYGENREQUEST: number;
|
||||||
|
const KEYEXPORTREQUEST: number;
|
||||||
|
const CIPHERREQUEST: number;
|
||||||
|
const DERIVEBITSREQUEST: number;
|
||||||
|
const HASHREQUEST: number;
|
||||||
|
const RANDOMBYTESREQUEST: number;
|
||||||
|
const RANDOMPRIMEREQUEST: number;
|
||||||
|
const SCRYPTREQUEST: number;
|
||||||
|
const SIGNREQUEST: number;
|
||||||
|
const TLSWRAP: number;
|
||||||
|
const VERIFYREQUEST: number;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
declare module "node:async_hooks" {
|
||||||
|
export * from "async_hooks";
|
||||||
|
}
|
||||||
+471
@@ -0,0 +1,471 @@
|
|||||||
|
declare module "buffer" {
|
||||||
|
type ImplicitArrayBuffer<T extends WithImplicitCoercion<ArrayBufferLike>> = T extends
|
||||||
|
{ valueOf(): infer V extends ArrayBufferLike } ? V : T;
|
||||||
|
global {
|
||||||
|
interface BufferConstructor {
|
||||||
|
// see buffer.d.ts for implementation shared with all TypeScript versions
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allocates a new buffer containing the given {str}.
|
||||||
|
*
|
||||||
|
* @param str String to store in buffer.
|
||||||
|
* @param encoding encoding to use, optional. Default is 'utf8'
|
||||||
|
* @deprecated since v10.0.0 - Use `Buffer.from(string[, encoding])` instead.
|
||||||
|
*/
|
||||||
|
new(str: string, encoding?: BufferEncoding): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Allocates a new buffer of {size} octets.
|
||||||
|
*
|
||||||
|
* @param size count of octets to allocate.
|
||||||
|
* @deprecated since v10.0.0 - Use `Buffer.alloc()` instead (also see `Buffer.allocUnsafe()`).
|
||||||
|
*/
|
||||||
|
new(size: number): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Allocates a new buffer containing the given {array} of octets.
|
||||||
|
*
|
||||||
|
* @param array The octets to store.
|
||||||
|
* @deprecated since v10.0.0 - Use `Buffer.from(array)` instead.
|
||||||
|
*/
|
||||||
|
new(array: ArrayLike<number>): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Produces a Buffer backed by the same allocated memory as
|
||||||
|
* the given {ArrayBuffer}/{SharedArrayBuffer}.
|
||||||
|
*
|
||||||
|
* @param arrayBuffer The ArrayBuffer with which to share memory.
|
||||||
|
* @deprecated since v10.0.0 - Use `Buffer.from(arrayBuffer[, byteOffset[, length]])` instead.
|
||||||
|
*/
|
||||||
|
new<TArrayBuffer extends ArrayBufferLike = ArrayBuffer>(arrayBuffer: TArrayBuffer): Buffer<TArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`.
|
||||||
|
* Array entries outside that range will be truncated to fit into it.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* // Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
|
||||||
|
* const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* If `array` is an `Array`-like object (that is, one with a `length` property of
|
||||||
|
* type `number`), it is treated as if it is an array, unless it is a `Buffer` or
|
||||||
|
* a `Uint8Array`. This means all other `TypedArray` variants get treated as an
|
||||||
|
* `Array`. To create a `Buffer` from the bytes backing a `TypedArray`, use
|
||||||
|
* `Buffer.copyBytesFrom()`.
|
||||||
|
*
|
||||||
|
* A `TypeError` will be thrown if `array` is not an `Array` or another type
|
||||||
|
* appropriate for `Buffer.from()` variants.
|
||||||
|
*
|
||||||
|
* `Buffer.from(array)` and `Buffer.from(string)` may also use the internal
|
||||||
|
* `Buffer` pool like `Buffer.allocUnsafe()` does.
|
||||||
|
* @since v5.10.0
|
||||||
|
*/
|
||||||
|
from(array: WithImplicitCoercion<ArrayLike<number>>): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* This creates a view of the `ArrayBuffer` without copying the underlying
|
||||||
|
* memory. For example, when passed a reference to the `.buffer` property of a
|
||||||
|
* `TypedArray` instance, the newly created `Buffer` will share the same
|
||||||
|
* allocated memory as the `TypedArray`'s underlying `ArrayBuffer`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const arr = new Uint16Array(2);
|
||||||
|
*
|
||||||
|
* arr[0] = 5000;
|
||||||
|
* arr[1] = 4000;
|
||||||
|
*
|
||||||
|
* // Shares memory with `arr`.
|
||||||
|
* const buf = Buffer.from(arr.buffer);
|
||||||
|
*
|
||||||
|
* console.log(buf);
|
||||||
|
* // Prints: <Buffer 88 13 a0 0f>
|
||||||
|
*
|
||||||
|
* // Changing the original Uint16Array changes the Buffer also.
|
||||||
|
* arr[1] = 6000;
|
||||||
|
*
|
||||||
|
* console.log(buf);
|
||||||
|
* // Prints: <Buffer 88 13 70 17>
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The optional `byteOffset` and `length` arguments specify a memory range within
|
||||||
|
* the `arrayBuffer` that will be shared by the `Buffer`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const ab = new ArrayBuffer(10);
|
||||||
|
* const buf = Buffer.from(ab, 0, 2);
|
||||||
|
*
|
||||||
|
* console.log(buf.length);
|
||||||
|
* // Prints: 2
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* A `TypeError` will be thrown if `arrayBuffer` is not an `ArrayBuffer` or a
|
||||||
|
* `SharedArrayBuffer` or another type appropriate for `Buffer.from()`
|
||||||
|
* variants.
|
||||||
|
*
|
||||||
|
* It is important to remember that a backing `ArrayBuffer` can cover a range
|
||||||
|
* of memory that extends beyond the bounds of a `TypedArray` view. A new
|
||||||
|
* `Buffer` created using the `buffer` property of a `TypedArray` may extend
|
||||||
|
* beyond the range of the `TypedArray`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const arrA = Uint8Array.from([0x63, 0x64, 0x65, 0x66]); // 4 elements
|
||||||
|
* const arrB = new Uint8Array(arrA.buffer, 1, 2); // 2 elements
|
||||||
|
* console.log(arrA.buffer === arrB.buffer); // true
|
||||||
|
*
|
||||||
|
* const buf = Buffer.from(arrB.buffer);
|
||||||
|
* console.log(buf);
|
||||||
|
* // Prints: <Buffer 63 64 65 66>
|
||||||
|
* ```
|
||||||
|
* @since v5.10.0
|
||||||
|
* @param arrayBuffer An `ArrayBuffer`, `SharedArrayBuffer`, for example the
|
||||||
|
* `.buffer` property of a `TypedArray`.
|
||||||
|
* @param byteOffset Index of first byte to expose. **Default:** `0`.
|
||||||
|
* @param length Number of bytes to expose. **Default:**
|
||||||
|
* `arrayBuffer.byteLength - byteOffset`.
|
||||||
|
*/
|
||||||
|
from<TArrayBuffer extends WithImplicitCoercion<ArrayBufferLike>>(
|
||||||
|
arrayBuffer: TArrayBuffer,
|
||||||
|
byteOffset?: number,
|
||||||
|
length?: number,
|
||||||
|
): Buffer<ImplicitArrayBuffer<TArrayBuffer>>;
|
||||||
|
/**
|
||||||
|
* Creates a new `Buffer` containing `string`. The `encoding` parameter identifies
|
||||||
|
* the character encoding to be used when converting `string` into bytes.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const buf1 = Buffer.from('this is a tést');
|
||||||
|
* const buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');
|
||||||
|
*
|
||||||
|
* console.log(buf1.toString());
|
||||||
|
* // Prints: this is a tést
|
||||||
|
* console.log(buf2.toString());
|
||||||
|
* // Prints: this is a tést
|
||||||
|
* console.log(buf1.toString('latin1'));
|
||||||
|
* // Prints: this is a tést
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* A `TypeError` will be thrown if `string` is not a string or another type
|
||||||
|
* appropriate for `Buffer.from()` variants.
|
||||||
|
*
|
||||||
|
* `Buffer.from(string)` may also use the internal `Buffer` pool like
|
||||||
|
* `Buffer.allocUnsafe()` does.
|
||||||
|
* @since v5.10.0
|
||||||
|
* @param string A string to encode.
|
||||||
|
* @param encoding The encoding of `string`. **Default:** `'utf8'`.
|
||||||
|
*/
|
||||||
|
from(string: WithImplicitCoercion<string>, encoding?: BufferEncoding): Buffer<ArrayBuffer>;
|
||||||
|
from(arrayOrString: WithImplicitCoercion<ArrayLike<number> | string>): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Creates a new Buffer using the passed {data}
|
||||||
|
* @param values to create a new Buffer
|
||||||
|
*/
|
||||||
|
of(...items: number[]): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Returns a new `Buffer` which is the result of concatenating all the `Buffer` instances in the `list` together.
|
||||||
|
*
|
||||||
|
* If the list has no items, or if the `totalLength` is 0, then a new zero-length `Buffer` is returned.
|
||||||
|
*
|
||||||
|
* If `totalLength` is not provided, it is calculated from the `Buffer` instances
|
||||||
|
* in `list` by adding their lengths.
|
||||||
|
*
|
||||||
|
* If `totalLength` is provided, it is coerced to an unsigned integer. If the
|
||||||
|
* combined length of the `Buffer`s in `list` exceeds `totalLength`, the result is
|
||||||
|
* truncated to `totalLength`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* // Create a single `Buffer` from a list of three `Buffer` instances.
|
||||||
|
*
|
||||||
|
* const buf1 = Buffer.alloc(10);
|
||||||
|
* const buf2 = Buffer.alloc(14);
|
||||||
|
* const buf3 = Buffer.alloc(18);
|
||||||
|
* const totalLength = buf1.length + buf2.length + buf3.length;
|
||||||
|
*
|
||||||
|
* console.log(totalLength);
|
||||||
|
* // Prints: 42
|
||||||
|
*
|
||||||
|
* const bufA = Buffer.concat([buf1, buf2, buf3], totalLength);
|
||||||
|
*
|
||||||
|
* console.log(bufA);
|
||||||
|
* // Prints: <Buffer 00 00 00 00 ...>
|
||||||
|
* console.log(bufA.length);
|
||||||
|
* // Prints: 42
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* `Buffer.concat()` may also use the internal `Buffer` pool like `Buffer.allocUnsafe()` does.
|
||||||
|
* @since v0.7.11
|
||||||
|
* @param list List of `Buffer` or {@link Uint8Array} instances to concatenate.
|
||||||
|
* @param totalLength Total length of the `Buffer` instances in `list` when concatenated.
|
||||||
|
*/
|
||||||
|
concat(list: readonly Uint8Array[], totalLength?: number): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Copies the underlying memory of `view` into a new `Buffer`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const u16 = new Uint16Array([0, 0xffff]);
|
||||||
|
* const buf = Buffer.copyBytesFrom(u16, 1, 1);
|
||||||
|
* u16[1] = 0;
|
||||||
|
* console.log(buf.length); // 2
|
||||||
|
* console.log(buf[0]); // 255
|
||||||
|
* console.log(buf[1]); // 255
|
||||||
|
* ```
|
||||||
|
* @since v19.8.0
|
||||||
|
* @param view The {TypedArray} to copy.
|
||||||
|
* @param [offset=0] The starting offset within `view`.
|
||||||
|
* @param [length=view.length - offset] The number of elements from `view` to copy.
|
||||||
|
*/
|
||||||
|
copyBytesFrom(view: NodeJS.TypedArray, offset?: number, length?: number): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the`Buffer` will be zero-filled.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const buf = Buffer.alloc(5);
|
||||||
|
*
|
||||||
|
* console.log(buf);
|
||||||
|
* // Prints: <Buffer 00 00 00 00 00>
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_OUT_OF_RANGE` is thrown.
|
||||||
|
*
|
||||||
|
* If `fill` is specified, the allocated `Buffer` will be initialized by calling `buf.fill(fill)`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const buf = Buffer.alloc(5, 'a');
|
||||||
|
*
|
||||||
|
* console.log(buf);
|
||||||
|
* // Prints: <Buffer 61 61 61 61 61>
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* If both `fill` and `encoding` are specified, the allocated `Buffer` will be
|
||||||
|
* initialized by calling `buf.fill(fill, encoding)`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
|
||||||
|
*
|
||||||
|
* console.log(buf);
|
||||||
|
* // Prints: <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Calling `Buffer.alloc()` can be measurably slower than the alternative `Buffer.allocUnsafe()` but ensures that the newly created `Buffer` instance
|
||||||
|
* contents will never contain sensitive data from previous allocations, including
|
||||||
|
* data that might not have been allocated for `Buffer`s.
|
||||||
|
*
|
||||||
|
* A `TypeError` will be thrown if `size` is not a number.
|
||||||
|
* @since v5.10.0
|
||||||
|
* @param size The desired length of the new `Buffer`.
|
||||||
|
* @param [fill=0] A value to pre-fill the new `Buffer` with.
|
||||||
|
* @param [encoding='utf8'] If `fill` is a string, this is its encoding.
|
||||||
|
*/
|
||||||
|
alloc(size: number, fill?: string | Uint8Array | number, encoding?: BufferEncoding): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Allocates a new `Buffer` of `size` bytes. If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_OUT_OF_RANGE` is thrown.
|
||||||
|
*
|
||||||
|
* The underlying memory for `Buffer` instances created in this way is _not_
|
||||||
|
* _initialized_. The contents of the newly created `Buffer` are unknown and _may contain sensitive data_. Use `Buffer.alloc()` instead to initialize`Buffer` instances with zeroes.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const buf = Buffer.allocUnsafe(10);
|
||||||
|
*
|
||||||
|
* console.log(buf);
|
||||||
|
* // Prints (contents may vary): <Buffer a0 8b 28 3f 01 00 00 00 50 32>
|
||||||
|
*
|
||||||
|
* buf.fill(0);
|
||||||
|
*
|
||||||
|
* console.log(buf);
|
||||||
|
* // Prints: <Buffer 00 00 00 00 00 00 00 00 00 00>
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* A `TypeError` will be thrown if `size` is not a number.
|
||||||
|
*
|
||||||
|
* The `Buffer` module pre-allocates an internal `Buffer` instance of
|
||||||
|
* size `Buffer.poolSize` that is used as a pool for the fast allocation of new `Buffer` instances created using `Buffer.allocUnsafe()`, `Buffer.from(array)`,
|
||||||
|
* and `Buffer.concat()` only when `size` is less than `Buffer.poolSize >>> 1` (floor of `Buffer.poolSize` divided by two).
|
||||||
|
*
|
||||||
|
* Use of this pre-allocated internal memory pool is a key difference between
|
||||||
|
* calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
|
||||||
|
* Specifically, `Buffer.alloc(size, fill)` will _never_ use the internal `Buffer`pool, while `Buffer.allocUnsafe(size).fill(fill)`_will_ use the internal`Buffer` pool if `size` is less
|
||||||
|
* than or equal to half `Buffer.poolSize`. The
|
||||||
|
* difference is subtle but can be important when an application requires the
|
||||||
|
* additional performance that `Buffer.allocUnsafe()` provides.
|
||||||
|
* @since v5.10.0
|
||||||
|
* @param size The desired length of the new `Buffer`.
|
||||||
|
*/
|
||||||
|
allocUnsafe(size: number): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Allocates a new `Buffer` of `size` bytes. If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_OUT_OF_RANGE` is thrown. A zero-length `Buffer` is created if
|
||||||
|
* `size` is 0.
|
||||||
|
*
|
||||||
|
* The underlying memory for `Buffer` instances created in this way is _not_
|
||||||
|
* _initialized_. The contents of the newly created `Buffer` are unknown and _may contain sensitive data_. Use `buf.fill(0)` to initialize
|
||||||
|
* such `Buffer` instances with zeroes.
|
||||||
|
*
|
||||||
|
* When using `Buffer.allocUnsafe()` to allocate new `Buffer` instances,
|
||||||
|
* allocations under 4 KiB are sliced from a single pre-allocated `Buffer`. This
|
||||||
|
* allows applications to avoid the garbage collection overhead of creating many
|
||||||
|
* individually allocated `Buffer` instances. This approach improves both
|
||||||
|
* performance and memory usage by eliminating the need to track and clean up as
|
||||||
|
* many individual `ArrayBuffer` objects.
|
||||||
|
*
|
||||||
|
* However, in the case where a developer may need to retain a small chunk of
|
||||||
|
* memory from a pool for an indeterminate amount of time, it may be appropriate
|
||||||
|
* to create an un-pooled `Buffer` instance using `Buffer.allocUnsafeSlow()` and
|
||||||
|
* then copying out the relevant bits.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* // Need to keep around a few small chunks of memory.
|
||||||
|
* const store = [];
|
||||||
|
*
|
||||||
|
* socket.on('readable', () => {
|
||||||
|
* let data;
|
||||||
|
* while (null !== (data = readable.read())) {
|
||||||
|
* // Allocate for retained data.
|
||||||
|
* const sb = Buffer.allocUnsafeSlow(10);
|
||||||
|
*
|
||||||
|
* // Copy the data into the new allocation.
|
||||||
|
* data.copy(sb, 0, 0, 10);
|
||||||
|
*
|
||||||
|
* store.push(sb);
|
||||||
|
* }
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* A `TypeError` will be thrown if `size` is not a number.
|
||||||
|
* @since v5.12.0
|
||||||
|
* @param size The desired length of the new `Buffer`.
|
||||||
|
*/
|
||||||
|
allocUnsafeSlow(size: number): Buffer<ArrayBuffer>;
|
||||||
|
}
|
||||||
|
interface Buffer<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike> extends Uint8Array<TArrayBuffer> {
|
||||||
|
// see buffer.d.ts for implementation shared with all TypeScript versions
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a new `Buffer` that references the same memory as the original, but
|
||||||
|
* offset and cropped by the `start` and `end` indices.
|
||||||
|
*
|
||||||
|
* This method is not compatible with the `Uint8Array.prototype.slice()`,
|
||||||
|
* which is a superclass of `Buffer`. To copy the slice, use`Uint8Array.prototype.slice()`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const buf = Buffer.from('buffer');
|
||||||
|
*
|
||||||
|
* const copiedBuf = Uint8Array.prototype.slice.call(buf);
|
||||||
|
* copiedBuf[0]++;
|
||||||
|
* console.log(copiedBuf.toString());
|
||||||
|
* // Prints: cuffer
|
||||||
|
*
|
||||||
|
* console.log(buf.toString());
|
||||||
|
* // Prints: buffer
|
||||||
|
*
|
||||||
|
* // With buf.slice(), the original buffer is modified.
|
||||||
|
* const notReallyCopiedBuf = buf.slice();
|
||||||
|
* notReallyCopiedBuf[0]++;
|
||||||
|
* console.log(notReallyCopiedBuf.toString());
|
||||||
|
* // Prints: cuffer
|
||||||
|
* console.log(buf.toString());
|
||||||
|
* // Also prints: cuffer (!)
|
||||||
|
* ```
|
||||||
|
* @since v0.3.0
|
||||||
|
* @deprecated Use `subarray` instead.
|
||||||
|
* @param [start=0] Where the new `Buffer` will start.
|
||||||
|
* @param [end=buf.length] Where the new `Buffer` will end (not inclusive).
|
||||||
|
*/
|
||||||
|
slice(start?: number, end?: number): Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* Returns a new `Buffer` that references the same memory as the original, but
|
||||||
|
* offset and cropped by the `start` and `end` indices.
|
||||||
|
*
|
||||||
|
* Specifying `end` greater than `buf.length` will return the same result as
|
||||||
|
* that of `end` equal to `buf.length`.
|
||||||
|
*
|
||||||
|
* This method is inherited from [`TypedArray.prototype.subarray()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/subarray).
|
||||||
|
*
|
||||||
|
* Modifying the new `Buffer` slice will modify the memory in the original `Buffer`because the allocated memory of the two objects overlap.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* // Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
|
||||||
|
* // from the original `Buffer`.
|
||||||
|
*
|
||||||
|
* const buf1 = Buffer.allocUnsafe(26);
|
||||||
|
*
|
||||||
|
* for (let i = 0; i < 26; i++) {
|
||||||
|
* // 97 is the decimal ASCII value for 'a'.
|
||||||
|
* buf1[i] = i + 97;
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* const buf2 = buf1.subarray(0, 3);
|
||||||
|
*
|
||||||
|
* console.log(buf2.toString('ascii', 0, buf2.length));
|
||||||
|
* // Prints: abc
|
||||||
|
*
|
||||||
|
* buf1[0] = 33;
|
||||||
|
*
|
||||||
|
* console.log(buf2.toString('ascii', 0, buf2.length));
|
||||||
|
* // Prints: !bc
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Specifying negative indexes causes the slice to be generated relative to the
|
||||||
|
* end of `buf` rather than the beginning.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const buf = Buffer.from('buffer');
|
||||||
|
*
|
||||||
|
* console.log(buf.subarray(-6, -1).toString());
|
||||||
|
* // Prints: buffe
|
||||||
|
* // (Equivalent to buf.subarray(0, 5).)
|
||||||
|
*
|
||||||
|
* console.log(buf.subarray(-6, -2).toString());
|
||||||
|
* // Prints: buff
|
||||||
|
* // (Equivalent to buf.subarray(0, 4).)
|
||||||
|
*
|
||||||
|
* console.log(buf.subarray(-5, -2).toString());
|
||||||
|
* // Prints: uff
|
||||||
|
* // (Equivalent to buf.subarray(1, 4).)
|
||||||
|
* ```
|
||||||
|
* @since v3.0.0
|
||||||
|
* @param [start=0] Where the new `Buffer` will start.
|
||||||
|
* @param [end=buf.length] Where the new `Buffer` will end (not inclusive).
|
||||||
|
*/
|
||||||
|
subarray(start?: number, end?: number): Buffer<TArrayBuffer>;
|
||||||
|
}
|
||||||
|
// TODO: remove globals in future version
|
||||||
|
/**
|
||||||
|
* @deprecated This is intended for internal use, and will be removed once `@types/node` no longer supports
|
||||||
|
* TypeScript versions earlier than 5.7.
|
||||||
|
*/
|
||||||
|
type NonSharedBuffer = Buffer<ArrayBuffer>;
|
||||||
|
/**
|
||||||
|
* @deprecated This is intended for internal use, and will be removed once `@types/node` no longer supports
|
||||||
|
* TypeScript versions earlier than 5.7.
|
||||||
|
*/
|
||||||
|
type AllowSharedBuffer = Buffer<ArrayBufferLike>;
|
||||||
|
}
|
||||||
|
/** @deprecated Use `Buffer.allocUnsafeSlow()` instead. */
|
||||||
|
var SlowBuffer: {
|
||||||
|
/** @deprecated Use `Buffer.allocUnsafeSlow()` instead. */
|
||||||
|
new(size: number): Buffer<ArrayBuffer>;
|
||||||
|
prototype: Buffer;
|
||||||
|
};
|
||||||
|
}
|
||||||
+1936
File diff suppressed because it is too large
Load Diff
+1475
File diff suppressed because it is too large
Load Diff
+577
@@ -0,0 +1,577 @@
|
|||||||
|
/**
|
||||||
|
* Clusters of Node.js processes can be used to run multiple instances of Node.js
|
||||||
|
* that can distribute workloads among their application threads. When process isolation
|
||||||
|
* is not needed, use the [`worker_threads`](https://nodejs.org/docs/latest-v20.x/api/worker_threads.html)
|
||||||
|
* module instead, which allows running multiple application threads within a single Node.js instance.
|
||||||
|
*
|
||||||
|
* The cluster module allows easy creation of child processes that all share
|
||||||
|
* server ports.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import cluster from 'node:cluster';
|
||||||
|
* import http from 'node:http';
|
||||||
|
* import { availableParallelism } from 'node:os';
|
||||||
|
* import process from 'node:process';
|
||||||
|
*
|
||||||
|
* const numCPUs = availableParallelism();
|
||||||
|
*
|
||||||
|
* if (cluster.isPrimary) {
|
||||||
|
* console.log(`Primary ${process.pid} is running`);
|
||||||
|
*
|
||||||
|
* // Fork workers.
|
||||||
|
* for (let i = 0; i < numCPUs; i++) {
|
||||||
|
* cluster.fork();
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* cluster.on('exit', (worker, code, signal) => {
|
||||||
|
* console.log(`worker ${worker.process.pid} died`);
|
||||||
|
* });
|
||||||
|
* } else {
|
||||||
|
* // Workers can share any TCP connection
|
||||||
|
* // In this case it is an HTTP server
|
||||||
|
* http.createServer((req, res) => {
|
||||||
|
* res.writeHead(200);
|
||||||
|
* res.end('hello world\n');
|
||||||
|
* }).listen(8000);
|
||||||
|
*
|
||||||
|
* console.log(`Worker ${process.pid} started`);
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Running Node.js will now share port 8000 between the workers:
|
||||||
|
*
|
||||||
|
* ```console
|
||||||
|
* $ node server.js
|
||||||
|
* Primary 3596 is running
|
||||||
|
* Worker 4324 started
|
||||||
|
* Worker 4520 started
|
||||||
|
* Worker 6056 started
|
||||||
|
* Worker 5644 started
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* On Windows, it is not yet possible to set up a named pipe server in a worker.
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/cluster.js)
|
||||||
|
*/
|
||||||
|
declare module "cluster" {
|
||||||
|
import * as child from "node:child_process";
|
||||||
|
import EventEmitter = require("node:events");
|
||||||
|
import * as net from "node:net";
|
||||||
|
type SerializationType = "json" | "advanced";
|
||||||
|
export interface ClusterSettings {
|
||||||
|
/**
|
||||||
|
* List of string arguments passed to the Node.js executable.
|
||||||
|
* @default process.execArgv
|
||||||
|
*/
|
||||||
|
execArgv?: string[] | undefined;
|
||||||
|
/**
|
||||||
|
* File path to worker file.
|
||||||
|
* @default process.argv[1]
|
||||||
|
*/
|
||||||
|
exec?: string | undefined;
|
||||||
|
/**
|
||||||
|
* String arguments passed to worker.
|
||||||
|
* @default process.argv.slice(2)
|
||||||
|
*/
|
||||||
|
args?: readonly string[] | undefined;
|
||||||
|
/**
|
||||||
|
* Whether or not to send output to parent's stdio.
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
silent?: boolean | undefined;
|
||||||
|
/**
|
||||||
|
* Configures the stdio of forked processes. Because the cluster module relies on IPC to function, this configuration must
|
||||||
|
* contain an `'ipc'` entry. When this option is provided, it overrides `silent`. See [`child_prcess.spawn()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processspawncommand-args-options)'s
|
||||||
|
* [`stdio`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#optionsstdio).
|
||||||
|
*/
|
||||||
|
stdio?: any[] | undefined;
|
||||||
|
/**
|
||||||
|
* Sets the user identity of the process. (See [`setuid(2)`](https://man7.org/linux/man-pages/man2/setuid.2.html).)
|
||||||
|
*/
|
||||||
|
uid?: number | undefined;
|
||||||
|
/**
|
||||||
|
* Sets the group identity of the process. (See [`setgid(2)`](https://man7.org/linux/man-pages/man2/setgid.2.html).)
|
||||||
|
*/
|
||||||
|
gid?: number | undefined;
|
||||||
|
/**
|
||||||
|
* Sets inspector port of worker. This can be a number, or a function that takes no arguments and returns a number.
|
||||||
|
* By default each worker gets its own port, incremented from the primary's `process.debugPort`.
|
||||||
|
*/
|
||||||
|
inspectPort?: number | (() => number) | undefined;
|
||||||
|
/**
|
||||||
|
* Specify the kind of serialization used for sending messages between processes. Possible values are `'json'` and `'advanced'`.
|
||||||
|
* See [Advanced serialization for `child_process`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#advanced-serialization) for more details.
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
serialization?: SerializationType | undefined;
|
||||||
|
/**
|
||||||
|
* Current working directory of the worker process.
|
||||||
|
* @default undefined (inherits from parent process)
|
||||||
|
*/
|
||||||
|
cwd?: string | undefined;
|
||||||
|
/**
|
||||||
|
* Hide the forked processes console window that would normally be created on Windows systems.
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
windowsHide?: boolean | undefined;
|
||||||
|
}
|
||||||
|
export interface Address {
|
||||||
|
address: string;
|
||||||
|
port: number;
|
||||||
|
/**
|
||||||
|
* The `addressType` is one of:
|
||||||
|
*
|
||||||
|
* * `4` (TCPv4)
|
||||||
|
* * `6` (TCPv6)
|
||||||
|
* * `-1` (Unix domain socket)
|
||||||
|
* * `'udp4'` or `'udp6'` (UDPv4 or UDPv6)
|
||||||
|
*/
|
||||||
|
addressType: 4 | 6 | -1 | "udp4" | "udp6";
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* A `Worker` object contains all public information and method about a worker.
|
||||||
|
* In the primary it can be obtained using `cluster.workers`. In a worker
|
||||||
|
* it can be obtained using `cluster.worker`.
|
||||||
|
* @since v0.7.0
|
||||||
|
*/
|
||||||
|
export class Worker extends EventEmitter {
|
||||||
|
/**
|
||||||
|
* Each new worker is given its own unique id, this id is stored in the `id`.
|
||||||
|
*
|
||||||
|
* While a worker is alive, this is the key that indexes it in `cluster.workers`.
|
||||||
|
* @since v0.8.0
|
||||||
|
*/
|
||||||
|
id: number;
|
||||||
|
/**
|
||||||
|
* All workers are created using [`child_process.fork()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processforkmodulepath-args-options), the returned object
|
||||||
|
* from this function is stored as `.process`. In a worker, the global `process` is stored.
|
||||||
|
*
|
||||||
|
* See: [Child Process module](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processforkmodulepath-args-options).
|
||||||
|
*
|
||||||
|
* Workers will call `process.exit(0)` if the `'disconnect'` event occurs
|
||||||
|
* on `process` and `.exitedAfterDisconnect` is not `true`. This protects against
|
||||||
|
* accidental disconnection.
|
||||||
|
* @since v0.7.0
|
||||||
|
*/
|
||||||
|
process: child.ChildProcess;
|
||||||
|
/**
|
||||||
|
* Send a message to a worker or primary, optionally with a handle.
|
||||||
|
*
|
||||||
|
* In the primary, this sends a message to a specific worker. It is identical to [`ChildProcess.send()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#subprocesssendmessage-sendhandle-options-callback).
|
||||||
|
*
|
||||||
|
* In a worker, this sends a message to the primary. It is identical to `process.send()`.
|
||||||
|
*
|
||||||
|
* This example will echo back all messages from the primary:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* if (cluster.isPrimary) {
|
||||||
|
* const worker = cluster.fork();
|
||||||
|
* worker.send('hi there');
|
||||||
|
*
|
||||||
|
* } else if (cluster.isWorker) {
|
||||||
|
* process.on('message', (msg) => {
|
||||||
|
* process.send(msg);
|
||||||
|
* });
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.7.0
|
||||||
|
* @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles.
|
||||||
|
*/
|
||||||
|
send(message: child.Serializable, callback?: (error: Error | null) => void): boolean;
|
||||||
|
send(
|
||||||
|
message: child.Serializable,
|
||||||
|
sendHandle: child.SendHandle,
|
||||||
|
callback?: (error: Error | null) => void,
|
||||||
|
): boolean;
|
||||||
|
send(
|
||||||
|
message: child.Serializable,
|
||||||
|
sendHandle: child.SendHandle,
|
||||||
|
options?: child.MessageOptions,
|
||||||
|
callback?: (error: Error | null) => void,
|
||||||
|
): boolean;
|
||||||
|
/**
|
||||||
|
* This function will kill the worker. In the primary worker, it does this by
|
||||||
|
* disconnecting the `worker.process`, and once disconnected, killing with `signal`. In the worker, it does it by killing the process with `signal`.
|
||||||
|
*
|
||||||
|
* The `kill()` function kills the worker process without waiting for a graceful
|
||||||
|
* disconnect, it has the same behavior as `worker.process.kill()`.
|
||||||
|
*
|
||||||
|
* This method is aliased as `worker.destroy()` for backwards compatibility.
|
||||||
|
*
|
||||||
|
* In a worker, `process.kill()` exists, but it is not this function;
|
||||||
|
* it is [`kill()`](https://nodejs.org/docs/latest-v20.x/api/process.html#processkillpid-signal).
|
||||||
|
* @since v0.9.12
|
||||||
|
* @param [signal='SIGTERM'] Name of the kill signal to send to the worker process.
|
||||||
|
*/
|
||||||
|
kill(signal?: string): void;
|
||||||
|
destroy(signal?: string): void;
|
||||||
|
/**
|
||||||
|
* In a worker, this function will close all servers, wait for the `'close'` event
|
||||||
|
* on those servers, and then disconnect the IPC channel.
|
||||||
|
*
|
||||||
|
* In the primary, an internal message is sent to the worker causing it to call `.disconnect()` on itself.
|
||||||
|
*
|
||||||
|
* Causes `.exitedAfterDisconnect` to be set.
|
||||||
|
*
|
||||||
|
* After a server is closed, it will no longer accept new connections,
|
||||||
|
* but connections may be accepted by any other listening worker. Existing
|
||||||
|
* connections will be allowed to close as usual. When no more connections exist,
|
||||||
|
* see `server.close()`, the IPC channel to the worker will close allowing it
|
||||||
|
* to die gracefully.
|
||||||
|
*
|
||||||
|
* The above applies _only_ to server connections, client connections are not
|
||||||
|
* automatically closed by workers, and disconnect does not wait for them to close
|
||||||
|
* before exiting.
|
||||||
|
*
|
||||||
|
* In a worker, `process.disconnect` exists, but it is not this function;
|
||||||
|
* it is `disconnect()`.
|
||||||
|
*
|
||||||
|
* Because long living server connections may block workers from disconnecting, it
|
||||||
|
* may be useful to send a message, so application specific actions may be taken to
|
||||||
|
* close them. It also may be useful to implement a timeout, killing a worker if
|
||||||
|
* the `'disconnect'` event has not been emitted after some time.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import net from 'node:net';
|
||||||
|
* if (cluster.isPrimary) {
|
||||||
|
* const worker = cluster.fork();
|
||||||
|
* let timeout;
|
||||||
|
*
|
||||||
|
* worker.on('listening', (address) => {
|
||||||
|
* worker.send('shutdown');
|
||||||
|
* worker.disconnect();
|
||||||
|
* timeout = setTimeout(() => {
|
||||||
|
* worker.kill();
|
||||||
|
* }, 2000);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* worker.on('disconnect', () => {
|
||||||
|
* clearTimeout(timeout);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* } else if (cluster.isWorker) {
|
||||||
|
* const server = net.createServer((socket) => {
|
||||||
|
* // Connections never end
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* server.listen(8000);
|
||||||
|
*
|
||||||
|
* process.on('message', (msg) => {
|
||||||
|
* if (msg === 'shutdown') {
|
||||||
|
* // Initiate graceful close of any connections to server
|
||||||
|
* }
|
||||||
|
* });
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.7.7
|
||||||
|
* @return A reference to `worker`.
|
||||||
|
*/
|
||||||
|
disconnect(): this;
|
||||||
|
/**
|
||||||
|
* This function returns `true` if the worker is connected to its primary via its
|
||||||
|
* IPC channel, `false` otherwise. A worker is connected to its primary after it
|
||||||
|
* has been created. It is disconnected after the `'disconnect'` event is emitted.
|
||||||
|
* @since v0.11.14
|
||||||
|
*/
|
||||||
|
isConnected(): boolean;
|
||||||
|
/**
|
||||||
|
* This function returns `true` if the worker's process has terminated (either
|
||||||
|
* because of exiting or being signaled). Otherwise, it returns `false`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import cluster from 'node:cluster';
|
||||||
|
* import http from 'node:http';
|
||||||
|
* import { availableParallelism } from 'node:os';
|
||||||
|
* import process from 'node:process';
|
||||||
|
*
|
||||||
|
* const numCPUs = availableParallelism();
|
||||||
|
*
|
||||||
|
* if (cluster.isPrimary) {
|
||||||
|
* console.log(`Primary ${process.pid} is running`);
|
||||||
|
*
|
||||||
|
* // Fork workers.
|
||||||
|
* for (let i = 0; i < numCPUs; i++) {
|
||||||
|
* cluster.fork();
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* cluster.on('fork', (worker) => {
|
||||||
|
* console.log('worker is dead:', worker.isDead());
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* cluster.on('exit', (worker, code, signal) => {
|
||||||
|
* console.log('worker is dead:', worker.isDead());
|
||||||
|
* });
|
||||||
|
* } else {
|
||||||
|
* // Workers can share any TCP connection. In this case, it is an HTTP server.
|
||||||
|
* http.createServer((req, res) => {
|
||||||
|
* res.writeHead(200);
|
||||||
|
* res.end(`Current process\n ${process.pid}`);
|
||||||
|
* process.kill(process.pid);
|
||||||
|
* }).listen(8000);
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.11.14
|
||||||
|
*/
|
||||||
|
isDead(): boolean;
|
||||||
|
/**
|
||||||
|
* This property is `true` if the worker exited due to `.disconnect()`.
|
||||||
|
* If the worker exited any other way, it is `false`. If the
|
||||||
|
* worker has not exited, it is `undefined`.
|
||||||
|
*
|
||||||
|
* The boolean `worker.exitedAfterDisconnect` allows distinguishing between
|
||||||
|
* voluntary and accidental exit, the primary may choose not to respawn a worker
|
||||||
|
* based on this value.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* cluster.on('exit', (worker, code, signal) => {
|
||||||
|
* if (worker.exitedAfterDisconnect === true) {
|
||||||
|
* console.log('Oh, it was just voluntary – no need to worry');
|
||||||
|
* }
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* // kill worker
|
||||||
|
* worker.kill();
|
||||||
|
* ```
|
||||||
|
* @since v6.0.0
|
||||||
|
*/
|
||||||
|
exitedAfterDisconnect: boolean;
|
||||||
|
/**
|
||||||
|
* events.EventEmitter
|
||||||
|
* 1. disconnect
|
||||||
|
* 2. error
|
||||||
|
* 3. exit
|
||||||
|
* 4. listening
|
||||||
|
* 5. message
|
||||||
|
* 6. online
|
||||||
|
*/
|
||||||
|
addListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
addListener(event: "disconnect", listener: () => void): this;
|
||||||
|
addListener(event: "error", listener: (error: Error) => void): this;
|
||||||
|
addListener(event: "exit", listener: (code: number, signal: string) => void): this;
|
||||||
|
addListener(event: "listening", listener: (address: Address) => void): this;
|
||||||
|
addListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
addListener(event: "online", listener: () => void): this;
|
||||||
|
emit(event: string | symbol, ...args: any[]): boolean;
|
||||||
|
emit(event: "disconnect"): boolean;
|
||||||
|
emit(event: "error", error: Error): boolean;
|
||||||
|
emit(event: "exit", code: number, signal: string): boolean;
|
||||||
|
emit(event: "listening", address: Address): boolean;
|
||||||
|
emit(event: "message", message: any, handle: net.Socket | net.Server): boolean;
|
||||||
|
emit(event: "online"): boolean;
|
||||||
|
on(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
on(event: "disconnect", listener: () => void): this;
|
||||||
|
on(event: "error", listener: (error: Error) => void): this;
|
||||||
|
on(event: "exit", listener: (code: number, signal: string) => void): this;
|
||||||
|
on(event: "listening", listener: (address: Address) => void): this;
|
||||||
|
on(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
on(event: "online", listener: () => void): this;
|
||||||
|
once(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
once(event: "disconnect", listener: () => void): this;
|
||||||
|
once(event: "error", listener: (error: Error) => void): this;
|
||||||
|
once(event: "exit", listener: (code: number, signal: string) => void): this;
|
||||||
|
once(event: "listening", listener: (address: Address) => void): this;
|
||||||
|
once(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
once(event: "online", listener: () => void): this;
|
||||||
|
prependListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
prependListener(event: "disconnect", listener: () => void): this;
|
||||||
|
prependListener(event: "error", listener: (error: Error) => void): this;
|
||||||
|
prependListener(event: "exit", listener: (code: number, signal: string) => void): this;
|
||||||
|
prependListener(event: "listening", listener: (address: Address) => void): this;
|
||||||
|
prependListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
prependListener(event: "online", listener: () => void): this;
|
||||||
|
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
prependOnceListener(event: "disconnect", listener: () => void): this;
|
||||||
|
prependOnceListener(event: "error", listener: (error: Error) => void): this;
|
||||||
|
prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this;
|
||||||
|
prependOnceListener(event: "listening", listener: (address: Address) => void): this;
|
||||||
|
prependOnceListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
prependOnceListener(event: "online", listener: () => void): this;
|
||||||
|
}
|
||||||
|
export interface Cluster extends EventEmitter {
|
||||||
|
disconnect(callback?: () => void): void;
|
||||||
|
/**
|
||||||
|
* Spawn a new worker process.
|
||||||
|
*
|
||||||
|
* This can only be called from the primary process.
|
||||||
|
* @param env Key/value pairs to add to worker process environment.
|
||||||
|
* @since v0.6.0
|
||||||
|
*/
|
||||||
|
fork(env?: any): Worker;
|
||||||
|
/** @deprecated since v16.0.0 - use isPrimary. */
|
||||||
|
readonly isMaster: boolean;
|
||||||
|
/**
|
||||||
|
* True if the process is a primary. This is determined by the `process.env.NODE_UNIQUE_ID`. If `process.env.NODE_UNIQUE_ID`
|
||||||
|
* is undefined, then `isPrimary` is `true`.
|
||||||
|
* @since v16.0.0
|
||||||
|
*/
|
||||||
|
readonly isPrimary: boolean;
|
||||||
|
/**
|
||||||
|
* True if the process is not a primary (it is the negation of `cluster.isPrimary`).
|
||||||
|
* @since v0.6.0
|
||||||
|
*/
|
||||||
|
readonly isWorker: boolean;
|
||||||
|
/**
|
||||||
|
* The scheduling policy, either `cluster.SCHED_RR` for round-robin or `cluster.SCHED_NONE` to leave it to the operating system. This is a
|
||||||
|
* global setting and effectively frozen once either the first worker is spawned, or [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings)
|
||||||
|
* is called, whichever comes first.
|
||||||
|
*
|
||||||
|
* `SCHED_RR` is the default on all operating systems except Windows. Windows will change to `SCHED_RR` once libuv is able to effectively distribute
|
||||||
|
* IOCP handles without incurring a large performance hit.
|
||||||
|
*
|
||||||
|
* `cluster.schedulingPolicy` can also be set through the `NODE_CLUSTER_SCHED_POLICY` environment variable. Valid values are `'rr'` and `'none'`.
|
||||||
|
* @since v0.11.2
|
||||||
|
*/
|
||||||
|
schedulingPolicy: number;
|
||||||
|
/**
|
||||||
|
* After calling [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings)
|
||||||
|
* (or [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv)) this settings object will contain
|
||||||
|
* the settings, including the default values.
|
||||||
|
*
|
||||||
|
* This object is not intended to be changed or set manually.
|
||||||
|
* @since v0.7.1
|
||||||
|
*/
|
||||||
|
readonly settings: ClusterSettings;
|
||||||
|
/** @deprecated since v16.0.0 - use [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings) instead. */
|
||||||
|
setupMaster(settings?: ClusterSettings): void;
|
||||||
|
/**
|
||||||
|
* `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in `cluster.settings`.
|
||||||
|
*
|
||||||
|
* Any settings changes only affect future calls to [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv)
|
||||||
|
* and have no effect on workers that are already running.
|
||||||
|
*
|
||||||
|
* The only attribute of a worker that cannot be set via `.setupPrimary()` is the `env` passed to
|
||||||
|
* [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv).
|
||||||
|
*
|
||||||
|
* The defaults above apply to the first call only; the defaults for later calls are the current values at the time of
|
||||||
|
* `cluster.setupPrimary()` is called.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import cluster from 'node:cluster';
|
||||||
|
*
|
||||||
|
* cluster.setupPrimary({
|
||||||
|
* exec: 'worker.js',
|
||||||
|
* args: ['--use', 'https'],
|
||||||
|
* silent: true,
|
||||||
|
* });
|
||||||
|
* cluster.fork(); // https worker
|
||||||
|
* cluster.setupPrimary({
|
||||||
|
* exec: 'worker.js',
|
||||||
|
* args: ['--use', 'http'],
|
||||||
|
* });
|
||||||
|
* cluster.fork(); // http worker
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* This can only be called from the primary process.
|
||||||
|
* @since v16.0.0
|
||||||
|
*/
|
||||||
|
setupPrimary(settings?: ClusterSettings): void;
|
||||||
|
/**
|
||||||
|
* A reference to the current worker object. Not available in the primary process.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import cluster from 'node:cluster';
|
||||||
|
*
|
||||||
|
* if (cluster.isPrimary) {
|
||||||
|
* console.log('I am primary');
|
||||||
|
* cluster.fork();
|
||||||
|
* cluster.fork();
|
||||||
|
* } else if (cluster.isWorker) {
|
||||||
|
* console.log(`I am worker #${cluster.worker.id}`);
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.7.0
|
||||||
|
*/
|
||||||
|
readonly worker?: Worker;
|
||||||
|
/**
|
||||||
|
* A hash that stores the active worker objects, keyed by `id` field. This makes it easy to loop through all the workers. It is only available in the primary process.
|
||||||
|
*
|
||||||
|
* A worker is removed from `cluster.workers` after the worker has disconnected _and_ exited. The order between these two events cannot be determined in advance. However, it
|
||||||
|
* is guaranteed that the removal from the `cluster.workers` list happens before the last `'disconnect'` or `'exit'` event is emitted.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import cluster from 'node:cluster';
|
||||||
|
*
|
||||||
|
* for (const worker of Object.values(cluster.workers)) {
|
||||||
|
* worker.send('big announcement to all workers');
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.7.0
|
||||||
|
*/
|
||||||
|
readonly workers?: NodeJS.Dict<Worker>;
|
||||||
|
readonly SCHED_NONE: number;
|
||||||
|
readonly SCHED_RR: number;
|
||||||
|
/**
|
||||||
|
* events.EventEmitter
|
||||||
|
* 1. disconnect
|
||||||
|
* 2. exit
|
||||||
|
* 3. fork
|
||||||
|
* 4. listening
|
||||||
|
* 5. message
|
||||||
|
* 6. online
|
||||||
|
* 7. setup
|
||||||
|
*/
|
||||||
|
addListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
addListener(event: "disconnect", listener: (worker: Worker) => void): this;
|
||||||
|
addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
|
||||||
|
addListener(event: "fork", listener: (worker: Worker) => void): this;
|
||||||
|
addListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
|
||||||
|
addListener(
|
||||||
|
event: "message",
|
||||||
|
listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void,
|
||||||
|
): this; // the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
addListener(event: "online", listener: (worker: Worker) => void): this;
|
||||||
|
addListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
|
||||||
|
emit(event: string | symbol, ...args: any[]): boolean;
|
||||||
|
emit(event: "disconnect", worker: Worker): boolean;
|
||||||
|
emit(event: "exit", worker: Worker, code: number, signal: string): boolean;
|
||||||
|
emit(event: "fork", worker: Worker): boolean;
|
||||||
|
emit(event: "listening", worker: Worker, address: Address): boolean;
|
||||||
|
emit(event: "message", worker: Worker, message: any, handle: net.Socket | net.Server): boolean;
|
||||||
|
emit(event: "online", worker: Worker): boolean;
|
||||||
|
emit(event: "setup", settings: ClusterSettings): boolean;
|
||||||
|
on(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
on(event: "disconnect", listener: (worker: Worker) => void): this;
|
||||||
|
on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
|
||||||
|
on(event: "fork", listener: (worker: Worker) => void): this;
|
||||||
|
on(event: "listening", listener: (worker: Worker, address: Address) => void): this;
|
||||||
|
on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
on(event: "online", listener: (worker: Worker) => void): this;
|
||||||
|
on(event: "setup", listener: (settings: ClusterSettings) => void): this;
|
||||||
|
once(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
once(event: "disconnect", listener: (worker: Worker) => void): this;
|
||||||
|
once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
|
||||||
|
once(event: "fork", listener: (worker: Worker) => void): this;
|
||||||
|
once(event: "listening", listener: (worker: Worker, address: Address) => void): this;
|
||||||
|
once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
once(event: "online", listener: (worker: Worker) => void): this;
|
||||||
|
once(event: "setup", listener: (settings: ClusterSettings) => void): this;
|
||||||
|
prependListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
prependListener(event: "disconnect", listener: (worker: Worker) => void): this;
|
||||||
|
prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
|
||||||
|
prependListener(event: "fork", listener: (worker: Worker) => void): this;
|
||||||
|
prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
|
||||||
|
prependListener(
|
||||||
|
event: "message",
|
||||||
|
listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void,
|
||||||
|
): this;
|
||||||
|
prependListener(event: "online", listener: (worker: Worker) => void): this;
|
||||||
|
prependListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
|
||||||
|
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): this;
|
||||||
|
prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
|
||||||
|
prependOnceListener(event: "fork", listener: (worker: Worker) => void): this;
|
||||||
|
prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
|
||||||
|
// the handle is a net.Socket or net.Server object, or undefined.
|
||||||
|
prependOnceListener(
|
||||||
|
event: "message",
|
||||||
|
listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void,
|
||||||
|
): this;
|
||||||
|
prependOnceListener(event: "online", listener: (worker: Worker) => void): this;
|
||||||
|
prependOnceListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
|
||||||
|
}
|
||||||
|
const cluster: Cluster;
|
||||||
|
export default cluster;
|
||||||
|
}
|
||||||
|
declare module "node:cluster" {
|
||||||
|
export * from "cluster";
|
||||||
|
export { default as default } from "cluster";
|
||||||
|
}
|
||||||
+16
@@ -0,0 +1,16 @@
|
|||||||
|
// Polyfills for the explicit resource management types added in TypeScript 5.2.
|
||||||
|
// TODO: remove once this package no longer supports TS 5.1, and replace with a
|
||||||
|
// <reference> to TypeScript's disposable library in index.d.ts.
|
||||||
|
|
||||||
|
interface SymbolConstructor {
|
||||||
|
readonly dispose: unique symbol;
|
||||||
|
readonly asyncDispose: unique symbol;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Disposable {
|
||||||
|
[Symbol.dispose](): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AsyncDisposable {
|
||||||
|
[Symbol.asyncDispose](): PromiseLike<void>;
|
||||||
|
}
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
// Declaration files in this directory contain types relating to TypeScript library features
|
||||||
|
// that are not included in all TypeScript versions supported by DefinitelyTyped, but
|
||||||
|
// which can be made backwards-compatible without needing `typesVersions`.
|
||||||
|
// If adding declarations to this directory, please specify which versions of TypeScript require them,
|
||||||
|
// so that they can be removed when no longer needed.
|
||||||
|
|
||||||
|
/// <reference path="disposable.d.ts" />
|
||||||
|
/// <reference path="indexable.d.ts" />
|
||||||
|
/// <reference path="iterators.d.ts" />
|
||||||
+20
@@ -0,0 +1,20 @@
|
|||||||
|
// Polyfill for ES2022's .at() method on string/array prototypes, added to TypeScript in 4.6.
|
||||||
|
|
||||||
|
interface RelativeIndexable<T> {
|
||||||
|
at(index: number): T | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface String extends RelativeIndexable<string> {}
|
||||||
|
interface Array<T> extends RelativeIndexable<T> {}
|
||||||
|
interface ReadonlyArray<T> extends RelativeIndexable<T> {}
|
||||||
|
interface Int8Array extends RelativeIndexable<number> {}
|
||||||
|
interface Uint8Array extends RelativeIndexable<number> {}
|
||||||
|
interface Uint8ClampedArray extends RelativeIndexable<number> {}
|
||||||
|
interface Int16Array extends RelativeIndexable<number> {}
|
||||||
|
interface Uint16Array extends RelativeIndexable<number> {}
|
||||||
|
interface Int32Array extends RelativeIndexable<number> {}
|
||||||
|
interface Uint32Array extends RelativeIndexable<number> {}
|
||||||
|
interface Float32Array extends RelativeIndexable<number> {}
|
||||||
|
interface Float64Array extends RelativeIndexable<number> {}
|
||||||
|
interface BigInt64Array extends RelativeIndexable<bigint> {}
|
||||||
|
interface BigUint64Array extends RelativeIndexable<bigint> {}
|
||||||
+21
@@ -0,0 +1,21 @@
|
|||||||
|
// Backwards-compatible iterator interfaces, augmented with iterator helper methods by lib.esnext.iterator in TypeScript 5.6.
|
||||||
|
// The IterableIterator interface does not contain these methods, which creates assignability issues in places where IteratorObjects
|
||||||
|
// are expected (eg. DOM-compatible APIs) if lib.esnext.iterator is loaded.
|
||||||
|
// Also ensures that iterators returned by the Node API, which inherit from Iterator.prototype, correctly expose the iterator helper methods
|
||||||
|
// if lib.esnext.iterator is loaded.
|
||||||
|
// TODO: remove once this package no longer supports TS 5.5, and replace NodeJS.BuiltinIteratorReturn with BuiltinIteratorReturn.
|
||||||
|
|
||||||
|
// Placeholders for TS <5.6
|
||||||
|
interface IteratorObject<T, TReturn, TNext> {}
|
||||||
|
interface AsyncIteratorObject<T, TReturn, TNext> {}
|
||||||
|
|
||||||
|
declare namespace NodeJS {
|
||||||
|
// Populate iterator methods for TS <5.6
|
||||||
|
interface Iterator<T, TReturn, TNext> extends globalThis.Iterator<T, TReturn, TNext> {}
|
||||||
|
interface AsyncIterator<T, TReturn, TNext> extends globalThis.AsyncIterator<T, TReturn, TNext> {}
|
||||||
|
|
||||||
|
// Polyfill for TS 5.6's instrinsic BuiltinIteratorReturn type, required for DOM-compatible iterators
|
||||||
|
type BuiltinIteratorReturn = ReturnType<any[][typeof Symbol.iterator]> extends
|
||||||
|
globalThis.Iterator<any, infer TReturn> ? TReturn
|
||||||
|
: any;
|
||||||
|
}
|
||||||
+452
@@ -0,0 +1,452 @@
|
|||||||
|
/**
|
||||||
|
* The `node:console` module provides a simple debugging console that is similar to
|
||||||
|
* the JavaScript console mechanism provided by web browsers.
|
||||||
|
*
|
||||||
|
* The module exports two specific components:
|
||||||
|
*
|
||||||
|
* * A `Console` class with methods such as `console.log()`, `console.error()`, and `console.warn()` that can be used to write to any Node.js stream.
|
||||||
|
* * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstdout) and
|
||||||
|
* [`process.stderr`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstderr). The global `console` can be used without importing the `node:console` module.
|
||||||
|
*
|
||||||
|
* _**Warning**_: The global console object's methods are neither consistently
|
||||||
|
* synchronous like the browser APIs they resemble, nor are they consistently
|
||||||
|
* asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v20.x/api/process.html#a-note-on-process-io) for
|
||||||
|
* more information.
|
||||||
|
*
|
||||||
|
* Example using the global `console`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* console.log('hello world');
|
||||||
|
* // Prints: hello world, to stdout
|
||||||
|
* console.log('hello %s', 'world');
|
||||||
|
* // Prints: hello world, to stdout
|
||||||
|
* console.error(new Error('Whoops, something bad happened'));
|
||||||
|
* // Prints error message and stack trace to stderr:
|
||||||
|
* // Error: Whoops, something bad happened
|
||||||
|
* // at [eval]:5:15
|
||||||
|
* // at Script.runInThisContext (node:vm:132:18)
|
||||||
|
* // at Object.runInThisContext (node:vm:309:38)
|
||||||
|
* // at node:internal/process/execution:77:19
|
||||||
|
* // at [eval]-wrapper:6:22
|
||||||
|
* // at evalScript (node:internal/process/execution:76:60)
|
||||||
|
* // at node:internal/main/eval_string:23:3
|
||||||
|
*
|
||||||
|
* const name = 'Will Robinson';
|
||||||
|
* console.warn(`Danger ${name}! Danger!`);
|
||||||
|
* // Prints: Danger Will Robinson! Danger!, to stderr
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Example using the `Console` class:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const out = getStreamSomehow();
|
||||||
|
* const err = getStreamSomehow();
|
||||||
|
* const myConsole = new console.Console(out, err);
|
||||||
|
*
|
||||||
|
* myConsole.log('hello world');
|
||||||
|
* // Prints: hello world, to out
|
||||||
|
* myConsole.log('hello %s', 'world');
|
||||||
|
* // Prints: hello world, to out
|
||||||
|
* myConsole.error(new Error('Whoops, something bad happened'));
|
||||||
|
* // Prints: [Error: Whoops, something bad happened], to err
|
||||||
|
*
|
||||||
|
* const name = 'Will Robinson';
|
||||||
|
* myConsole.warn(`Danger ${name}! Danger!`);
|
||||||
|
* // Prints: Danger Will Robinson! Danger!, to err
|
||||||
|
* ```
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/console.js)
|
||||||
|
*/
|
||||||
|
declare module "console" {
|
||||||
|
import console = require("node:console");
|
||||||
|
export = console;
|
||||||
|
}
|
||||||
|
declare module "node:console" {
|
||||||
|
import { InspectOptions } from "node:util";
|
||||||
|
global {
|
||||||
|
// This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build
|
||||||
|
interface Console {
|
||||||
|
Console: console.ConsoleConstructor;
|
||||||
|
/**
|
||||||
|
* `console.assert()` writes a message if `value` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) or omitted. It only
|
||||||
|
* writes a message and does not otherwise affect execution. The output always
|
||||||
|
* starts with `"Assertion failed"`. If provided, `message` is formatted using
|
||||||
|
* [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args).
|
||||||
|
*
|
||||||
|
* If `value` is [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy), nothing happens.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* console.assert(true, 'does nothing');
|
||||||
|
*
|
||||||
|
* console.assert(false, 'Whoops %s work', 'didn\'t');
|
||||||
|
* // Assertion failed: Whoops didn't work
|
||||||
|
*
|
||||||
|
* console.assert();
|
||||||
|
* // Assertion failed
|
||||||
|
* ```
|
||||||
|
* @since v0.1.101
|
||||||
|
* @param value The value tested for being truthy.
|
||||||
|
* @param message All arguments besides `value` are used as error message.
|
||||||
|
*/
|
||||||
|
assert(value: any, message?: string, ...optionalParams: any[]): void;
|
||||||
|
/**
|
||||||
|
* When `stdout` is a TTY, calling `console.clear()` will attempt to clear the
|
||||||
|
* TTY. When `stdout` is not a TTY, this method does nothing.
|
||||||
|
*
|
||||||
|
* The specific operation of `console.clear()` can vary across operating systems
|
||||||
|
* and terminal types. For most Linux operating systems, `console.clear()` operates similarly to the `clear` shell command. On Windows, `console.clear()` will clear only the output in the
|
||||||
|
* current terminal viewport for the Node.js
|
||||||
|
* binary.
|
||||||
|
* @since v8.3.0
|
||||||
|
*/
|
||||||
|
clear(): void;
|
||||||
|
/**
|
||||||
|
* Maintains an internal counter specific to `label` and outputs to `stdout` the
|
||||||
|
* number of times `console.count()` has been called with the given `label`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* > console.count()
|
||||||
|
* default: 1
|
||||||
|
* undefined
|
||||||
|
* > console.count('default')
|
||||||
|
* default: 2
|
||||||
|
* undefined
|
||||||
|
* > console.count('abc')
|
||||||
|
* abc: 1
|
||||||
|
* undefined
|
||||||
|
* > console.count('xyz')
|
||||||
|
* xyz: 1
|
||||||
|
* undefined
|
||||||
|
* > console.count('abc')
|
||||||
|
* abc: 2
|
||||||
|
* undefined
|
||||||
|
* > console.count()
|
||||||
|
* default: 3
|
||||||
|
* undefined
|
||||||
|
* >
|
||||||
|
* ```
|
||||||
|
* @since v8.3.0
|
||||||
|
* @param [label='default'] The display label for the counter.
|
||||||
|
*/
|
||||||
|
count(label?: string): void;
|
||||||
|
/**
|
||||||
|
* Resets the internal counter specific to `label`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* > console.count('abc');
|
||||||
|
* abc: 1
|
||||||
|
* undefined
|
||||||
|
* > console.countReset('abc');
|
||||||
|
* undefined
|
||||||
|
* > console.count('abc');
|
||||||
|
* abc: 1
|
||||||
|
* undefined
|
||||||
|
* >
|
||||||
|
* ```
|
||||||
|
* @since v8.3.0
|
||||||
|
* @param [label='default'] The display label for the counter.
|
||||||
|
*/
|
||||||
|
countReset(label?: string): void;
|
||||||
|
/**
|
||||||
|
* The `console.debug()` function is an alias for {@link log}.
|
||||||
|
* @since v8.0.0
|
||||||
|
*/
|
||||||
|
debug(message?: any, ...optionalParams: any[]): void;
|
||||||
|
/**
|
||||||
|
* Uses [`util.inspect()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilinspectobject-options) on `obj` and prints the resulting string to `stdout`.
|
||||||
|
* This function bypasses any custom `inspect()` function defined on `obj`.
|
||||||
|
* @since v0.1.101
|
||||||
|
*/
|
||||||
|
dir(obj: any, options?: InspectOptions): void;
|
||||||
|
/**
|
||||||
|
* This method calls `console.log()` passing it the arguments received.
|
||||||
|
* This method does not produce any XML formatting.
|
||||||
|
* @since v8.0.0
|
||||||
|
*/
|
||||||
|
dirxml(...data: any[]): void;
|
||||||
|
/**
|
||||||
|
* Prints to `stderr` with newline. Multiple arguments can be passed, with the
|
||||||
|
* first used as the primary message and all additional used as substitution
|
||||||
|
* values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html)
|
||||||
|
* (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)).
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const code = 5;
|
||||||
|
* console.error('error #%d', code);
|
||||||
|
* // Prints: error #5, to stderr
|
||||||
|
* console.error('error', code);
|
||||||
|
* // Prints: error 5, to stderr
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* If formatting elements (e.g. `%d`) are not found in the first string then
|
||||||
|
* [`util.inspect()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilinspectobject-options) is called on each argument and the
|
||||||
|
* resulting string values are concatenated. See [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)
|
||||||
|
* for more information.
|
||||||
|
* @since v0.1.100
|
||||||
|
*/
|
||||||
|
error(message?: any, ...optionalParams: any[]): void;
|
||||||
|
/**
|
||||||
|
* Increases indentation of subsequent lines by spaces for `groupIndentation` length.
|
||||||
|
*
|
||||||
|
* If one or more `label`s are provided, those are printed first without the
|
||||||
|
* additional indentation.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
group(...label: any[]): void;
|
||||||
|
/**
|
||||||
|
* An alias for {@link group}.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
groupCollapsed(...label: any[]): void;
|
||||||
|
/**
|
||||||
|
* Decreases indentation of subsequent lines by spaces for `groupIndentation` length.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
groupEnd(): void;
|
||||||
|
/**
|
||||||
|
* The `console.info()` function is an alias for {@link log}.
|
||||||
|
* @since v0.1.100
|
||||||
|
*/
|
||||||
|
info(message?: any, ...optionalParams: any[]): void;
|
||||||
|
/**
|
||||||
|
* Prints to `stdout` with newline. Multiple arguments can be passed, with the
|
||||||
|
* first used as the primary message and all additional used as substitution
|
||||||
|
* values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html)
|
||||||
|
* (the arguments are all passed to [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)).
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const count = 5;
|
||||||
|
* console.log('count: %d', count);
|
||||||
|
* // Prints: count: 5, to stdout
|
||||||
|
* console.log('count:', count);
|
||||||
|
* // Prints: count: 5, to stdout
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* See [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args) for more information.
|
||||||
|
* @since v0.1.100
|
||||||
|
*/
|
||||||
|
log(message?: any, ...optionalParams: any[]): void;
|
||||||
|
/**
|
||||||
|
* Try to construct a table with the columns of the properties of `tabularData` (or use `properties`) and rows of `tabularData` and log it. Falls back to just
|
||||||
|
* logging the argument if it can't be parsed as tabular.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* // These can't be parsed as tabular data
|
||||||
|
* console.table(Symbol());
|
||||||
|
* // Symbol()
|
||||||
|
*
|
||||||
|
* console.table(undefined);
|
||||||
|
* // undefined
|
||||||
|
*
|
||||||
|
* console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }]);
|
||||||
|
* // ┌─────────┬─────┬─────┐
|
||||||
|
* // │ (index) │ a │ b │
|
||||||
|
* // ├─────────┼─────┼─────┤
|
||||||
|
* // │ 0 │ 1 │ 'Y' │
|
||||||
|
* // │ 1 │ 'Z' │ 2 │
|
||||||
|
* // └─────────┴─────┴─────┘
|
||||||
|
*
|
||||||
|
* console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);
|
||||||
|
* // ┌─────────┬─────┐
|
||||||
|
* // │ (index) │ a │
|
||||||
|
* // ├─────────┼─────┤
|
||||||
|
* // │ 0 │ 1 │
|
||||||
|
* // │ 1 │ 'Z' │
|
||||||
|
* // └─────────┴─────┘
|
||||||
|
* ```
|
||||||
|
* @since v10.0.0
|
||||||
|
* @param properties Alternate properties for constructing the table.
|
||||||
|
*/
|
||||||
|
table(tabularData: any, properties?: readonly string[]): void;
|
||||||
|
/**
|
||||||
|
* Starts a timer that can be used to compute the duration of an operation. Timers
|
||||||
|
* are identified by a unique `label`. Use the same `label` when calling {@link timeEnd} to stop the timer and output the elapsed time in
|
||||||
|
* suitable time units to `stdout`. For example, if the elapsed
|
||||||
|
* time is 3869ms, `console.timeEnd()` displays "3.869s".
|
||||||
|
* @since v0.1.104
|
||||||
|
* @param [label='default']
|
||||||
|
*/
|
||||||
|
time(label?: string): void;
|
||||||
|
/**
|
||||||
|
* Stops a timer that was previously started by calling {@link time} and
|
||||||
|
* prints the result to `stdout`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* console.time('bunch-of-stuff');
|
||||||
|
* // Do a bunch of stuff.
|
||||||
|
* console.timeEnd('bunch-of-stuff');
|
||||||
|
* // Prints: bunch-of-stuff: 225.438ms
|
||||||
|
* ```
|
||||||
|
* @since v0.1.104
|
||||||
|
* @param [label='default']
|
||||||
|
*/
|
||||||
|
timeEnd(label?: string): void;
|
||||||
|
/**
|
||||||
|
* For a timer that was previously started by calling {@link time}, prints
|
||||||
|
* the elapsed time and other `data` arguments to `stdout`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* console.time('process');
|
||||||
|
* const value = expensiveProcess1(); // Returns 42
|
||||||
|
* console.timeLog('process', value);
|
||||||
|
* // Prints "process: 365.227ms 42".
|
||||||
|
* doExpensiveProcess2(value);
|
||||||
|
* console.timeEnd('process');
|
||||||
|
* ```
|
||||||
|
* @since v10.7.0
|
||||||
|
* @param [label='default']
|
||||||
|
*/
|
||||||
|
timeLog(label?: string, ...data: any[]): void;
|
||||||
|
/**
|
||||||
|
* Prints to `stderr` the string `'Trace: '`, followed by the [`util.format()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilformatformat-args)
|
||||||
|
* formatted message and stack trace to the current position in the code.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* console.trace('Show me');
|
||||||
|
* // Prints: (stack trace will vary based on where trace is called)
|
||||||
|
* // Trace: Show me
|
||||||
|
* // at repl:2:9
|
||||||
|
* // at REPLServer.defaultEval (repl.js:248:27)
|
||||||
|
* // at bound (domain.js:287:14)
|
||||||
|
* // at REPLServer.runBound [as eval] (domain.js:300:12)
|
||||||
|
* // at REPLServer.<anonymous> (repl.js:412:12)
|
||||||
|
* // at emitOne (events.js:82:20)
|
||||||
|
* // at REPLServer.emit (events.js:169:7)
|
||||||
|
* // at REPLServer.Interface._onLine (readline.js:210:10)
|
||||||
|
* // at REPLServer.Interface._line (readline.js:549:8)
|
||||||
|
* // at REPLServer.Interface._ttyWrite (readline.js:826:14)
|
||||||
|
* ```
|
||||||
|
* @since v0.1.104
|
||||||
|
*/
|
||||||
|
trace(message?: any, ...optionalParams: any[]): void;
|
||||||
|
/**
|
||||||
|
* The `console.warn()` function is an alias for {@link error}.
|
||||||
|
* @since v0.1.100
|
||||||
|
*/
|
||||||
|
warn(message?: any, ...optionalParams: any[]): void;
|
||||||
|
// --- Inspector mode only ---
|
||||||
|
/**
|
||||||
|
* This method does not display anything unless used in the inspector. The `console.profile()`
|
||||||
|
* method starts a JavaScript CPU profile with an optional label until {@link profileEnd}
|
||||||
|
* is called. The profile is then added to the Profile panel of the inspector.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* console.profile('MyLabel');
|
||||||
|
* // Some code
|
||||||
|
* console.profileEnd('MyLabel');
|
||||||
|
* // Adds the profile 'MyLabel' to the Profiles panel of the inspector.
|
||||||
|
* ```
|
||||||
|
* @since v8.0.0
|
||||||
|
*/
|
||||||
|
profile(label?: string): void;
|
||||||
|
/**
|
||||||
|
* This method does not display anything unless used in the inspector. Stops the current
|
||||||
|
* JavaScript CPU profiling session if one has been started and prints the report to the
|
||||||
|
* Profiles panel of the inspector. See {@link profile} for an example.
|
||||||
|
*
|
||||||
|
* If this method is called without a label, the most recently started profile is stopped.
|
||||||
|
* @since v8.0.0
|
||||||
|
*/
|
||||||
|
profileEnd(label?: string): void;
|
||||||
|
/**
|
||||||
|
* This method does not display anything unless used in the inspector. The `console.timeStamp()`
|
||||||
|
* method adds an event with the label `'label'` to the Timeline panel of the inspector.
|
||||||
|
* @since v8.0.0
|
||||||
|
*/
|
||||||
|
timeStamp(label?: string): void;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The `console` module provides a simple debugging console that is similar to the
|
||||||
|
* JavaScript console mechanism provided by web browsers.
|
||||||
|
*
|
||||||
|
* The module exports two specific components:
|
||||||
|
*
|
||||||
|
* * A `Console` class with methods such as `console.log()`, `console.error()` and `console.warn()` that can be used to write to any Node.js stream.
|
||||||
|
* * A global `console` instance configured to write to [`process.stdout`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstdout) and
|
||||||
|
* [`process.stderr`](https://nodejs.org/docs/latest-v20.x/api/process.html#processstderr). The global `console` can be used without importing the `node:console` module.
|
||||||
|
*
|
||||||
|
* _**Warning**_: The global console object's methods are neither consistently
|
||||||
|
* synchronous like the browser APIs they resemble, nor are they consistently
|
||||||
|
* asynchronous like all other Node.js streams. See the [`note on process I/O`](https://nodejs.org/docs/latest-v20.x/api/process.html#a-note-on-process-io) for
|
||||||
|
* more information.
|
||||||
|
*
|
||||||
|
* Example using the global `console`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* console.log('hello world');
|
||||||
|
* // Prints: hello world, to stdout
|
||||||
|
* console.log('hello %s', 'world');
|
||||||
|
* // Prints: hello world, to stdout
|
||||||
|
* console.error(new Error('Whoops, something bad happened'));
|
||||||
|
* // Prints error message and stack trace to stderr:
|
||||||
|
* // Error: Whoops, something bad happened
|
||||||
|
* // at [eval]:5:15
|
||||||
|
* // at Script.runInThisContext (node:vm:132:18)
|
||||||
|
* // at Object.runInThisContext (node:vm:309:38)
|
||||||
|
* // at node:internal/process/execution:77:19
|
||||||
|
* // at [eval]-wrapper:6:22
|
||||||
|
* // at evalScript (node:internal/process/execution:76:60)
|
||||||
|
* // at node:internal/main/eval_string:23:3
|
||||||
|
*
|
||||||
|
* const name = 'Will Robinson';
|
||||||
|
* console.warn(`Danger ${name}! Danger!`);
|
||||||
|
* // Prints: Danger Will Robinson! Danger!, to stderr
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Example using the `Console` class:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const out = getStreamSomehow();
|
||||||
|
* const err = getStreamSomehow();
|
||||||
|
* const myConsole = new console.Console(out, err);
|
||||||
|
*
|
||||||
|
* myConsole.log('hello world');
|
||||||
|
* // Prints: hello world, to out
|
||||||
|
* myConsole.log('hello %s', 'world');
|
||||||
|
* // Prints: hello world, to out
|
||||||
|
* myConsole.error(new Error('Whoops, something bad happened'));
|
||||||
|
* // Prints: [Error: Whoops, something bad happened], to err
|
||||||
|
*
|
||||||
|
* const name = 'Will Robinson';
|
||||||
|
* myConsole.warn(`Danger ${name}! Danger!`);
|
||||||
|
* // Prints: Danger Will Robinson! Danger!, to err
|
||||||
|
* ```
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.11.1/lib/console.js)
|
||||||
|
*/
|
||||||
|
namespace console {
|
||||||
|
interface ConsoleConstructorOptions {
|
||||||
|
stdout: NodeJS.WritableStream;
|
||||||
|
stderr?: NodeJS.WritableStream | undefined;
|
||||||
|
/**
|
||||||
|
* Ignore errors when writing to the underlying streams.
|
||||||
|
* @default true
|
||||||
|
*/
|
||||||
|
ignoreErrors?: boolean | undefined;
|
||||||
|
/**
|
||||||
|
* Set color support for this `Console` instance. Setting to true enables coloring while inspecting
|
||||||
|
* values. Setting to `false` disables coloring while inspecting values. Setting to `'auto'` makes color
|
||||||
|
* support depend on the value of the `isTTY` property and the value returned by `getColorDepth()` on the
|
||||||
|
* respective stream. This option can not be used, if `inspectOptions.colors` is set as well.
|
||||||
|
* @default auto
|
||||||
|
*/
|
||||||
|
colorMode?: boolean | "auto" | undefined;
|
||||||
|
/**
|
||||||
|
* Specifies options that are passed along to
|
||||||
|
* [`util.inspect()`](https://nodejs.org/docs/latest-v20.x/api/util.html#utilinspectobject-options).
|
||||||
|
*/
|
||||||
|
inspectOptions?: InspectOptions | undefined;
|
||||||
|
/**
|
||||||
|
* Set group indentation.
|
||||||
|
* @default 2
|
||||||
|
*/
|
||||||
|
groupIndentation?: number | undefined;
|
||||||
|
}
|
||||||
|
interface ConsoleConstructor {
|
||||||
|
prototype: Console;
|
||||||
|
new(stdout: NodeJS.WritableStream, stderr?: NodeJS.WritableStream, ignoreErrors?: boolean): Console;
|
||||||
|
new(options: ConsoleConstructorOptions): Console;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var console: Console;
|
||||||
|
}
|
||||||
|
export = globalThis.console;
|
||||||
|
}
|
||||||
+21
@@ -0,0 +1,21 @@
|
|||||||
|
/**
|
||||||
|
* @deprecated The `node:constants` module is deprecated. When requiring access to constants
|
||||||
|
* relevant to specific Node.js builtin modules, developers should instead refer
|
||||||
|
* to the `constants` property exposed by the relevant module. For instance,
|
||||||
|
* `require('node:fs').constants` and `require('node:os').constants`.
|
||||||
|
*/
|
||||||
|
declare module "constants" {
|
||||||
|
const constants:
|
||||||
|
& typeof import("node:os").constants.dlopen
|
||||||
|
& typeof import("node:os").constants.errno
|
||||||
|
& typeof import("node:os").constants.priority
|
||||||
|
& typeof import("node:os").constants.signals
|
||||||
|
& typeof import("node:fs").constants
|
||||||
|
& typeof import("node:crypto").constants;
|
||||||
|
export = constants;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module "node:constants" {
|
||||||
|
import constants = require("constants");
|
||||||
|
export = constants;
|
||||||
|
}
|
||||||
+4590
File diff suppressed because it is too large
Load Diff
+597
@@ -0,0 +1,597 @@
|
|||||||
|
/**
|
||||||
|
* The `node:dgram` module provides an implementation of UDP datagram sockets.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dgram from 'node:dgram';
|
||||||
|
*
|
||||||
|
* const server = dgram.createSocket('udp4');
|
||||||
|
*
|
||||||
|
* server.on('error', (err) => {
|
||||||
|
* console.error(`server error:\n${err.stack}`);
|
||||||
|
* server.close();
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* server.on('message', (msg, rinfo) => {
|
||||||
|
* console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* server.on('listening', () => {
|
||||||
|
* const address = server.address();
|
||||||
|
* console.log(`server listening ${address.address}:${address.port}`);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* server.bind(41234);
|
||||||
|
* // Prints: server listening 0.0.0.0:41234
|
||||||
|
* ```
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/dgram.js)
|
||||||
|
*/
|
||||||
|
declare module "dgram" {
|
||||||
|
import { NonSharedBuffer } from "node:buffer";
|
||||||
|
import { AddressInfo } from "node:net";
|
||||||
|
import * as dns from "node:dns";
|
||||||
|
import { Abortable, EventEmitter } from "node:events";
|
||||||
|
interface RemoteInfo {
|
||||||
|
address: string;
|
||||||
|
family: "IPv4" | "IPv6";
|
||||||
|
port: number;
|
||||||
|
size: number;
|
||||||
|
}
|
||||||
|
interface BindOptions {
|
||||||
|
port?: number | undefined;
|
||||||
|
address?: string | undefined;
|
||||||
|
exclusive?: boolean | undefined;
|
||||||
|
fd?: number | undefined;
|
||||||
|
}
|
||||||
|
type SocketType = "udp4" | "udp6";
|
||||||
|
interface SocketOptions extends Abortable {
|
||||||
|
type: SocketType;
|
||||||
|
reuseAddr?: boolean | undefined;
|
||||||
|
/**
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
ipv6Only?: boolean | undefined;
|
||||||
|
recvBufferSize?: number | undefined;
|
||||||
|
sendBufferSize?: number | undefined;
|
||||||
|
lookup?:
|
||||||
|
| ((
|
||||||
|
hostname: string,
|
||||||
|
options: dns.LookupOneOptions,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void,
|
||||||
|
) => void)
|
||||||
|
| undefined;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Creates a `dgram.Socket` object. Once the socket is created, calling `socket.bind()` will instruct the socket to begin listening for datagram
|
||||||
|
* messages. When `address` and `port` are not passed to `socket.bind()` the
|
||||||
|
* method will bind the socket to the "all interfaces" address on a random port
|
||||||
|
* (it does the right thing for both `udp4` and `udp6` sockets). The bound address
|
||||||
|
* and port can be retrieved using `socket.address().address` and `socket.address().port`.
|
||||||
|
*
|
||||||
|
* If the `signal` option is enabled, calling `.abort()` on the corresponding `AbortController` is similar to calling `.close()` on the socket:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const controller = new AbortController();
|
||||||
|
* const { signal } = controller;
|
||||||
|
* const server = dgram.createSocket({ type: 'udp4', signal });
|
||||||
|
* server.on('message', (msg, rinfo) => {
|
||||||
|
* console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
|
||||||
|
* });
|
||||||
|
* // Later, when you want to close the server.
|
||||||
|
* controller.abort();
|
||||||
|
* ```
|
||||||
|
* @since v0.11.13
|
||||||
|
* @param options Available options are:
|
||||||
|
* @param callback Attached as a listener for `'message'` events. Optional.
|
||||||
|
*/
|
||||||
|
function createSocket(type: SocketType, callback?: (msg: NonSharedBuffer, rinfo: RemoteInfo) => void): Socket;
|
||||||
|
function createSocket(options: SocketOptions, callback?: (msg: NonSharedBuffer, rinfo: RemoteInfo) => void): Socket;
|
||||||
|
/**
|
||||||
|
* Encapsulates the datagram functionality.
|
||||||
|
*
|
||||||
|
* New instances of `dgram.Socket` are created using {@link createSocket}.
|
||||||
|
* The `new` keyword is not to be used to create `dgram.Socket` instances.
|
||||||
|
* @since v0.1.99
|
||||||
|
*/
|
||||||
|
class Socket extends EventEmitter {
|
||||||
|
/**
|
||||||
|
* Tells the kernel to join a multicast group at the given `multicastAddress` and `multicastInterface` using the `IP_ADD_MEMBERSHIP` socket option. If the `multicastInterface` argument is not
|
||||||
|
* specified, the operating system will choose
|
||||||
|
* one interface and will add membership to it. To add membership to every
|
||||||
|
* available interface, call `addMembership` multiple times, once per interface.
|
||||||
|
*
|
||||||
|
* When called on an unbound socket, this method will implicitly bind to a random
|
||||||
|
* port, listening on all interfaces.
|
||||||
|
*
|
||||||
|
* When sharing a UDP socket across multiple `cluster` workers, the`socket.addMembership()` function must be called only once or an`EADDRINUSE` error will occur:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import cluster from 'node:cluster';
|
||||||
|
* import dgram from 'node:dgram';
|
||||||
|
*
|
||||||
|
* if (cluster.isPrimary) {
|
||||||
|
* cluster.fork(); // Works ok.
|
||||||
|
* cluster.fork(); // Fails with EADDRINUSE.
|
||||||
|
* } else {
|
||||||
|
* const s = dgram.createSocket('udp4');
|
||||||
|
* s.bind(1234, () => {
|
||||||
|
* s.addMembership('224.0.0.114');
|
||||||
|
* });
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.6.9
|
||||||
|
*/
|
||||||
|
addMembership(multicastAddress: string, multicastInterface?: string): void;
|
||||||
|
/**
|
||||||
|
* Returns an object containing the address information for a socket.
|
||||||
|
* For UDP sockets, this object will contain `address`, `family`, and `port` properties.
|
||||||
|
*
|
||||||
|
* This method throws `EBADF` if called on an unbound socket.
|
||||||
|
* @since v0.1.99
|
||||||
|
*/
|
||||||
|
address(): AddressInfo;
|
||||||
|
/**
|
||||||
|
* For UDP sockets, causes the `dgram.Socket` to listen for datagram
|
||||||
|
* messages on a named `port` and optional `address`. If `port` is not
|
||||||
|
* specified or is `0`, the operating system will attempt to bind to a
|
||||||
|
* random port. If `address` is not specified, the operating system will
|
||||||
|
* attempt to listen on all addresses. Once binding is complete, a `'listening'` event is emitted and the optional `callback` function is
|
||||||
|
* called.
|
||||||
|
*
|
||||||
|
* Specifying both a `'listening'` event listener and passing a `callback` to the `socket.bind()` method is not harmful but not very
|
||||||
|
* useful.
|
||||||
|
*
|
||||||
|
* A bound datagram socket keeps the Node.js process running to receive
|
||||||
|
* datagram messages.
|
||||||
|
*
|
||||||
|
* If binding fails, an `'error'` event is generated. In rare case (e.g.
|
||||||
|
* attempting to bind with a closed socket), an `Error` may be thrown.
|
||||||
|
*
|
||||||
|
* Example of a UDP server listening on port 41234:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dgram from 'node:dgram';
|
||||||
|
*
|
||||||
|
* const server = dgram.createSocket('udp4');
|
||||||
|
*
|
||||||
|
* server.on('error', (err) => {
|
||||||
|
* console.error(`server error:\n${err.stack}`);
|
||||||
|
* server.close();
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* server.on('message', (msg, rinfo) => {
|
||||||
|
* console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* server.on('listening', () => {
|
||||||
|
* const address = server.address();
|
||||||
|
* console.log(`server listening ${address.address}:${address.port}`);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* server.bind(41234);
|
||||||
|
* // Prints: server listening 0.0.0.0:41234
|
||||||
|
* ```
|
||||||
|
* @since v0.1.99
|
||||||
|
* @param callback with no parameters. Called when binding is complete.
|
||||||
|
*/
|
||||||
|
bind(port?: number, address?: string, callback?: () => void): this;
|
||||||
|
bind(port?: number, callback?: () => void): this;
|
||||||
|
bind(callback?: () => void): this;
|
||||||
|
bind(options: BindOptions, callback?: () => void): this;
|
||||||
|
/**
|
||||||
|
* Close the underlying socket and stop listening for data on it. If a callback is
|
||||||
|
* provided, it is added as a listener for the `'close'` event.
|
||||||
|
* @since v0.1.99
|
||||||
|
* @param callback Called when the socket has been closed.
|
||||||
|
*/
|
||||||
|
close(callback?: () => void): this;
|
||||||
|
/**
|
||||||
|
* Associates the `dgram.Socket` to a remote address and port. Every
|
||||||
|
* message sent by this handle is automatically sent to that destination. Also,
|
||||||
|
* the socket will only receive messages from that remote peer.
|
||||||
|
* Trying to call `connect()` on an already connected socket will result
|
||||||
|
* in an `ERR_SOCKET_DGRAM_IS_CONNECTED` exception. If `address` is not
|
||||||
|
* provided, `'127.0.0.1'` (for `udp4` sockets) or `'::1'` (for `udp6` sockets)
|
||||||
|
* will be used by default. Once the connection is complete, a `'connect'` event
|
||||||
|
* is emitted and the optional `callback` function is called. In case of failure,
|
||||||
|
* the `callback` is called or, failing this, an `'error'` event is emitted.
|
||||||
|
* @since v12.0.0
|
||||||
|
* @param callback Called when the connection is completed or on error.
|
||||||
|
*/
|
||||||
|
connect(port: number, address?: string, callback?: () => void): void;
|
||||||
|
connect(port: number, callback: () => void): void;
|
||||||
|
/**
|
||||||
|
* A synchronous function that disassociates a connected `dgram.Socket` from
|
||||||
|
* its remote address. Trying to call `disconnect()` on an unbound or already
|
||||||
|
* disconnected socket will result in an `ERR_SOCKET_DGRAM_NOT_CONNECTED` exception.
|
||||||
|
* @since v12.0.0
|
||||||
|
*/
|
||||||
|
disconnect(): void;
|
||||||
|
/**
|
||||||
|
* Instructs the kernel to leave a multicast group at `multicastAddress` using the `IP_DROP_MEMBERSHIP` socket option. This method is automatically called by the
|
||||||
|
* kernel when the socket is closed or the process terminates, so most apps will
|
||||||
|
* never have reason to call this.
|
||||||
|
*
|
||||||
|
* If `multicastInterface` is not specified, the operating system will attempt to
|
||||||
|
* drop membership on all valid interfaces.
|
||||||
|
* @since v0.6.9
|
||||||
|
*/
|
||||||
|
dropMembership(multicastAddress: string, multicastInterface?: string): void;
|
||||||
|
/**
|
||||||
|
* This method throws `ERR_SOCKET_BUFFER_SIZE` if called on an unbound socket.
|
||||||
|
* @since v8.7.0
|
||||||
|
* @return the `SO_RCVBUF` socket receive buffer size in bytes.
|
||||||
|
*/
|
||||||
|
getRecvBufferSize(): number;
|
||||||
|
/**
|
||||||
|
* This method throws `ERR_SOCKET_BUFFER_SIZE` if called on an unbound socket.
|
||||||
|
* @since v8.7.0
|
||||||
|
* @return the `SO_SNDBUF` socket send buffer size in bytes.
|
||||||
|
*/
|
||||||
|
getSendBufferSize(): number;
|
||||||
|
/**
|
||||||
|
* @since v18.8.0, v16.19.0
|
||||||
|
* @return Number of bytes queued for sending.
|
||||||
|
*/
|
||||||
|
getSendQueueSize(): number;
|
||||||
|
/**
|
||||||
|
* @since v18.8.0, v16.19.0
|
||||||
|
* @return Number of send requests currently in the queue awaiting to be processed.
|
||||||
|
*/
|
||||||
|
getSendQueueCount(): number;
|
||||||
|
/**
|
||||||
|
* By default, binding a socket will cause it to block the Node.js process from
|
||||||
|
* exiting as long as the socket is open. The `socket.unref()` method can be used
|
||||||
|
* to exclude the socket from the reference counting that keeps the Node.js
|
||||||
|
* process active. The `socket.ref()` method adds the socket back to the reference
|
||||||
|
* counting and restores the default behavior.
|
||||||
|
*
|
||||||
|
* Calling `socket.ref()` multiples times will have no additional effect.
|
||||||
|
*
|
||||||
|
* The `socket.ref()` method returns a reference to the socket so calls can be
|
||||||
|
* chained.
|
||||||
|
* @since v0.9.1
|
||||||
|
*/
|
||||||
|
ref(): this;
|
||||||
|
/**
|
||||||
|
* Returns an object containing the `address`, `family`, and `port` of the remote
|
||||||
|
* endpoint. This method throws an `ERR_SOCKET_DGRAM_NOT_CONNECTED` exception
|
||||||
|
* if the socket is not connected.
|
||||||
|
* @since v12.0.0
|
||||||
|
*/
|
||||||
|
remoteAddress(): AddressInfo;
|
||||||
|
/**
|
||||||
|
* Broadcasts a datagram on the socket.
|
||||||
|
* For connectionless sockets, the destination `port` and `address` must be
|
||||||
|
* specified. Connected sockets, on the other hand, will use their associated
|
||||||
|
* remote endpoint, so the `port` and `address` arguments must not be set.
|
||||||
|
*
|
||||||
|
* The `msg` argument contains the message to be sent.
|
||||||
|
* Depending on its type, different behavior can apply. If `msg` is a `Buffer`,
|
||||||
|
* any `TypedArray` or a `DataView`,
|
||||||
|
* the `offset` and `length` specify the offset within the `Buffer` where the
|
||||||
|
* message begins and the number of bytes in the message, respectively.
|
||||||
|
* If `msg` is a `String`, then it is automatically converted to a `Buffer` with `'utf8'` encoding. With messages that
|
||||||
|
* contain multi-byte characters, `offset` and `length` will be calculated with
|
||||||
|
* respect to `byte length` and not the character position.
|
||||||
|
* If `msg` is an array, `offset` and `length` must not be specified.
|
||||||
|
*
|
||||||
|
* The `address` argument is a string. If the value of `address` is a host name,
|
||||||
|
* DNS will be used to resolve the address of the host. If `address` is not
|
||||||
|
* provided or otherwise nullish, `'127.0.0.1'` (for `udp4` sockets) or `'::1'` (for `udp6` sockets) will be used by default.
|
||||||
|
*
|
||||||
|
* If the socket has not been previously bound with a call to `bind`, the socket
|
||||||
|
* is assigned a random port number and is bound to the "all interfaces" address
|
||||||
|
* (`'0.0.0.0'` for `udp4` sockets, `'::0'` for `udp6` sockets.)
|
||||||
|
*
|
||||||
|
* An optional `callback` function may be specified to as a way of reporting
|
||||||
|
* DNS errors or for determining when it is safe to reuse the `buf` object.
|
||||||
|
* DNS lookups delay the time to send for at least one tick of the
|
||||||
|
* Node.js event loop.
|
||||||
|
*
|
||||||
|
* The only way to know for sure that the datagram has been sent is by using a `callback`. If an error occurs and a `callback` is given, the error will be
|
||||||
|
* passed as the first argument to the `callback`. If a `callback` is not given,
|
||||||
|
* the error is emitted as an `'error'` event on the `socket` object.
|
||||||
|
*
|
||||||
|
* Offset and length are optional but both _must_ be set if either are used.
|
||||||
|
* They are supported only when the first argument is a `Buffer`, a `TypedArray`,
|
||||||
|
* or a `DataView`.
|
||||||
|
*
|
||||||
|
* This method throws `ERR_SOCKET_BAD_PORT` if called on an unbound socket.
|
||||||
|
*
|
||||||
|
* Example of sending a UDP packet to a port on `localhost`;
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dgram from 'node:dgram';
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const message = Buffer.from('Some bytes');
|
||||||
|
* const client = dgram.createSocket('udp4');
|
||||||
|
* client.send(message, 41234, 'localhost', (err) => {
|
||||||
|
* client.close();
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Example of sending a UDP packet composed of multiple buffers to a port on`127.0.0.1`;
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dgram from 'node:dgram';
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const buf1 = Buffer.from('Some ');
|
||||||
|
* const buf2 = Buffer.from('bytes');
|
||||||
|
* const client = dgram.createSocket('udp4');
|
||||||
|
* client.send([buf1, buf2], 41234, (err) => {
|
||||||
|
* client.close();
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Sending multiple buffers might be faster or slower depending on the
|
||||||
|
* application and operating system. Run benchmarks to
|
||||||
|
* determine the optimal strategy on a case-by-case basis. Generally speaking,
|
||||||
|
* however, sending multiple buffers is faster.
|
||||||
|
*
|
||||||
|
* Example of sending a UDP packet using a socket connected to a port on `localhost`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dgram from 'node:dgram';
|
||||||
|
* import { Buffer } from 'node:buffer';
|
||||||
|
*
|
||||||
|
* const message = Buffer.from('Some bytes');
|
||||||
|
* const client = dgram.createSocket('udp4');
|
||||||
|
* client.connect(41234, 'localhost', (err) => {
|
||||||
|
* client.send(message, (err) => {
|
||||||
|
* client.close();
|
||||||
|
* });
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v0.1.99
|
||||||
|
* @param msg Message to be sent.
|
||||||
|
* @param offset Offset in the buffer where the message starts.
|
||||||
|
* @param length Number of bytes in the message.
|
||||||
|
* @param port Destination port.
|
||||||
|
* @param address Destination host name or IP address.
|
||||||
|
* @param callback Called when the message has been sent.
|
||||||
|
*/
|
||||||
|
send(
|
||||||
|
msg: string | NodeJS.ArrayBufferView | readonly any[],
|
||||||
|
port?: number,
|
||||||
|
address?: string,
|
||||||
|
callback?: (error: Error | null, bytes: number) => void,
|
||||||
|
): void;
|
||||||
|
send(
|
||||||
|
msg: string | NodeJS.ArrayBufferView | readonly any[],
|
||||||
|
port?: number,
|
||||||
|
callback?: (error: Error | null, bytes: number) => void,
|
||||||
|
): void;
|
||||||
|
send(
|
||||||
|
msg: string | NodeJS.ArrayBufferView | readonly any[],
|
||||||
|
callback?: (error: Error | null, bytes: number) => void,
|
||||||
|
): void;
|
||||||
|
send(
|
||||||
|
msg: string | NodeJS.ArrayBufferView,
|
||||||
|
offset: number,
|
||||||
|
length: number,
|
||||||
|
port?: number,
|
||||||
|
address?: string,
|
||||||
|
callback?: (error: Error | null, bytes: number) => void,
|
||||||
|
): void;
|
||||||
|
send(
|
||||||
|
msg: string | NodeJS.ArrayBufferView,
|
||||||
|
offset: number,
|
||||||
|
length: number,
|
||||||
|
port?: number,
|
||||||
|
callback?: (error: Error | null, bytes: number) => void,
|
||||||
|
): void;
|
||||||
|
send(
|
||||||
|
msg: string | NodeJS.ArrayBufferView,
|
||||||
|
offset: number,
|
||||||
|
length: number,
|
||||||
|
callback?: (error: Error | null, bytes: number) => void,
|
||||||
|
): void;
|
||||||
|
/**
|
||||||
|
* Sets or clears the `SO_BROADCAST` socket option. When set to `true`, UDP
|
||||||
|
* packets may be sent to a local interface's broadcast address.
|
||||||
|
*
|
||||||
|
* This method throws `EBADF` if called on an unbound socket.
|
||||||
|
* @since v0.6.9
|
||||||
|
*/
|
||||||
|
setBroadcast(flag: boolean): void;
|
||||||
|
/**
|
||||||
|
* _All references to scope in this section are referring to [IPv6 Zone Indices](https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses), which are defined by [RFC
|
||||||
|
* 4007](https://tools.ietf.org/html/rfc4007). In string form, an IP_
|
||||||
|
* _with a scope index is written as `'IP%scope'` where scope is an interface name_
|
||||||
|
* _or interface number._
|
||||||
|
*
|
||||||
|
* Sets the default outgoing multicast interface of the socket to a chosen
|
||||||
|
* interface or back to system interface selection. The `multicastInterface` must
|
||||||
|
* be a valid string representation of an IP from the socket's family.
|
||||||
|
*
|
||||||
|
* For IPv4 sockets, this should be the IP configured for the desired physical
|
||||||
|
* interface. All packets sent to multicast on the socket will be sent on the
|
||||||
|
* interface determined by the most recent successful use of this call.
|
||||||
|
*
|
||||||
|
* For IPv6 sockets, `multicastInterface` should include a scope to indicate the
|
||||||
|
* interface as in the examples that follow. In IPv6, individual `send` calls can
|
||||||
|
* also use explicit scope in addresses, so only packets sent to a multicast
|
||||||
|
* address without specifying an explicit scope are affected by the most recent
|
||||||
|
* successful use of this call.
|
||||||
|
*
|
||||||
|
* This method throws `EBADF` if called on an unbound socket.
|
||||||
|
*
|
||||||
|
* #### Example: IPv6 outgoing multicast interface
|
||||||
|
*
|
||||||
|
* On most systems, where scope format uses the interface name:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const socket = dgram.createSocket('udp6');
|
||||||
|
*
|
||||||
|
* socket.bind(1234, () => {
|
||||||
|
* socket.setMulticastInterface('::%eth1');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* On Windows, where scope format uses an interface number:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const socket = dgram.createSocket('udp6');
|
||||||
|
*
|
||||||
|
* socket.bind(1234, () => {
|
||||||
|
* socket.setMulticastInterface('::%2');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* #### Example: IPv4 outgoing multicast interface
|
||||||
|
*
|
||||||
|
* All systems use an IP of the host on the desired physical interface:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const socket = dgram.createSocket('udp4');
|
||||||
|
*
|
||||||
|
* socket.bind(1234, () => {
|
||||||
|
* socket.setMulticastInterface('10.0.0.2');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v8.6.0
|
||||||
|
*/
|
||||||
|
setMulticastInterface(multicastInterface: string): void;
|
||||||
|
/**
|
||||||
|
* Sets or clears the `IP_MULTICAST_LOOP` socket option. When set to `true`,
|
||||||
|
* multicast packets will also be received on the local interface.
|
||||||
|
*
|
||||||
|
* This method throws `EBADF` if called on an unbound socket.
|
||||||
|
* @since v0.3.8
|
||||||
|
*/
|
||||||
|
setMulticastLoopback(flag: boolean): boolean;
|
||||||
|
/**
|
||||||
|
* Sets the `IP_MULTICAST_TTL` socket option. While TTL generally stands for
|
||||||
|
* "Time to Live", in this context it specifies the number of IP hops that a
|
||||||
|
* packet is allowed to travel through, specifically for multicast traffic. Each
|
||||||
|
* router or gateway that forwards a packet decrements the TTL. If the TTL is
|
||||||
|
* decremented to 0 by a router, it will not be forwarded.
|
||||||
|
*
|
||||||
|
* The `ttl` argument may be between 0 and 255\. The default on most systems is `1`.
|
||||||
|
*
|
||||||
|
* This method throws `EBADF` if called on an unbound socket.
|
||||||
|
* @since v0.3.8
|
||||||
|
*/
|
||||||
|
setMulticastTTL(ttl: number): number;
|
||||||
|
/**
|
||||||
|
* Sets the `SO_RCVBUF` socket option. Sets the maximum socket receive buffer
|
||||||
|
* in bytes.
|
||||||
|
*
|
||||||
|
* This method throws `ERR_SOCKET_BUFFER_SIZE` if called on an unbound socket.
|
||||||
|
* @since v8.7.0
|
||||||
|
*/
|
||||||
|
setRecvBufferSize(size: number): void;
|
||||||
|
/**
|
||||||
|
* Sets the `SO_SNDBUF` socket option. Sets the maximum socket send buffer
|
||||||
|
* in bytes.
|
||||||
|
*
|
||||||
|
* This method throws `ERR_SOCKET_BUFFER_SIZE` if called on an unbound socket.
|
||||||
|
* @since v8.7.0
|
||||||
|
*/
|
||||||
|
setSendBufferSize(size: number): void;
|
||||||
|
/**
|
||||||
|
* Sets the `IP_TTL` socket option. While TTL generally stands for "Time to Live",
|
||||||
|
* in this context it specifies the number of IP hops that a packet is allowed to
|
||||||
|
* travel through. Each router or gateway that forwards a packet decrements the
|
||||||
|
* TTL. If the TTL is decremented to 0 by a router, it will not be forwarded.
|
||||||
|
* Changing TTL values is typically done for network probes or when multicasting.
|
||||||
|
*
|
||||||
|
* The `ttl` argument may be between 1 and 255\. The default on most systems
|
||||||
|
* is 64.
|
||||||
|
*
|
||||||
|
* This method throws `EBADF` if called on an unbound socket.
|
||||||
|
* @since v0.1.101
|
||||||
|
*/
|
||||||
|
setTTL(ttl: number): number;
|
||||||
|
/**
|
||||||
|
* By default, binding a socket will cause it to block the Node.js process from
|
||||||
|
* exiting as long as the socket is open. The `socket.unref()` method can be used
|
||||||
|
* to exclude the socket from the reference counting that keeps the Node.js
|
||||||
|
* process active, allowing the process to exit even if the socket is still
|
||||||
|
* listening.
|
||||||
|
*
|
||||||
|
* Calling `socket.unref()` multiple times will have no additional effect.
|
||||||
|
*
|
||||||
|
* The `socket.unref()` method returns a reference to the socket so calls can be
|
||||||
|
* chained.
|
||||||
|
* @since v0.9.1
|
||||||
|
*/
|
||||||
|
unref(): this;
|
||||||
|
/**
|
||||||
|
* Tells the kernel to join a source-specific multicast channel at the given `sourceAddress` and `groupAddress`, using the `multicastInterface` with the `IP_ADD_SOURCE_MEMBERSHIP` socket
|
||||||
|
* option. If the `multicastInterface` argument
|
||||||
|
* is not specified, the operating system will choose one interface and will add
|
||||||
|
* membership to it. To add membership to every available interface, call `socket.addSourceSpecificMembership()` multiple times, once per interface.
|
||||||
|
*
|
||||||
|
* When called on an unbound socket, this method will implicitly bind to a random
|
||||||
|
* port, listening on all interfaces.
|
||||||
|
* @since v13.1.0, v12.16.0
|
||||||
|
*/
|
||||||
|
addSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void;
|
||||||
|
/**
|
||||||
|
* Instructs the kernel to leave a source-specific multicast channel at the given `sourceAddress` and `groupAddress` using the `IP_DROP_SOURCE_MEMBERSHIP` socket option. This method is
|
||||||
|
* automatically called by the kernel when the
|
||||||
|
* socket is closed or the process terminates, so most apps will never have
|
||||||
|
* reason to call this.
|
||||||
|
*
|
||||||
|
* If `multicastInterface` is not specified, the operating system will attempt to
|
||||||
|
* drop membership on all valid interfaces.
|
||||||
|
* @since v13.1.0, v12.16.0
|
||||||
|
*/
|
||||||
|
dropSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void;
|
||||||
|
/**
|
||||||
|
* events.EventEmitter
|
||||||
|
* 1. close
|
||||||
|
* 2. connect
|
||||||
|
* 3. error
|
||||||
|
* 4. listening
|
||||||
|
* 5. message
|
||||||
|
*/
|
||||||
|
addListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
addListener(event: "close", listener: () => void): this;
|
||||||
|
addListener(event: "connect", listener: () => void): this;
|
||||||
|
addListener(event: "error", listener: (err: Error) => void): this;
|
||||||
|
addListener(event: "listening", listener: () => void): this;
|
||||||
|
addListener(event: "message", listener: (msg: NonSharedBuffer, rinfo: RemoteInfo) => void): this;
|
||||||
|
emit(event: string | symbol, ...args: any[]): boolean;
|
||||||
|
emit(event: "close"): boolean;
|
||||||
|
emit(event: "connect"): boolean;
|
||||||
|
emit(event: "error", err: Error): boolean;
|
||||||
|
emit(event: "listening"): boolean;
|
||||||
|
emit(event: "message", msg: NonSharedBuffer, rinfo: RemoteInfo): boolean;
|
||||||
|
on(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
on(event: "close", listener: () => void): this;
|
||||||
|
on(event: "connect", listener: () => void): this;
|
||||||
|
on(event: "error", listener: (err: Error) => void): this;
|
||||||
|
on(event: "listening", listener: () => void): this;
|
||||||
|
on(event: "message", listener: (msg: NonSharedBuffer, rinfo: RemoteInfo) => void): this;
|
||||||
|
once(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
once(event: "close", listener: () => void): this;
|
||||||
|
once(event: "connect", listener: () => void): this;
|
||||||
|
once(event: "error", listener: (err: Error) => void): this;
|
||||||
|
once(event: "listening", listener: () => void): this;
|
||||||
|
once(event: "message", listener: (msg: NonSharedBuffer, rinfo: RemoteInfo) => void): this;
|
||||||
|
prependListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
prependListener(event: "close", listener: () => void): this;
|
||||||
|
prependListener(event: "connect", listener: () => void): this;
|
||||||
|
prependListener(event: "error", listener: (err: Error) => void): this;
|
||||||
|
prependListener(event: "listening", listener: () => void): this;
|
||||||
|
prependListener(event: "message", listener: (msg: NonSharedBuffer, rinfo: RemoteInfo) => void): this;
|
||||||
|
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
prependOnceListener(event: "close", listener: () => void): this;
|
||||||
|
prependOnceListener(event: "connect", listener: () => void): this;
|
||||||
|
prependOnceListener(event: "error", listener: (err: Error) => void): this;
|
||||||
|
prependOnceListener(event: "listening", listener: () => void): this;
|
||||||
|
prependOnceListener(event: "message", listener: (msg: NonSharedBuffer, rinfo: RemoteInfo) => void): this;
|
||||||
|
/**
|
||||||
|
* Calls `socket.close()` and returns a promise that fulfills when the socket has closed.
|
||||||
|
* @since v20.5.0
|
||||||
|
*/
|
||||||
|
[Symbol.asyncDispose](): Promise<void>;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
declare module "node:dgram" {
|
||||||
|
export * from "dgram";
|
||||||
|
}
|
||||||
+578
@@ -0,0 +1,578 @@
|
|||||||
|
/**
|
||||||
|
* The `node:diagnostics_channel` module provides an API to create named channels
|
||||||
|
* to report arbitrary message data for diagnostics purposes.
|
||||||
|
*
|
||||||
|
* It can be accessed using:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* It is intended that a module writer wanting to report diagnostics messages
|
||||||
|
* will create one or many top-level channels to report messages through.
|
||||||
|
* Channels may also be acquired at runtime but it is not encouraged
|
||||||
|
* due to the additional overhead of doing so. Channels may be exported for
|
||||||
|
* convenience, but as long as the name is known it can be acquired anywhere.
|
||||||
|
*
|
||||||
|
* If you intend for your module to produce diagnostics data for others to
|
||||||
|
* consume it is recommended that you include documentation of what named
|
||||||
|
* channels are used along with the shape of the message data. Channel names
|
||||||
|
* should generally include the module name to avoid collisions with data from
|
||||||
|
* other modules.
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/diagnostics_channel.js)
|
||||||
|
*/
|
||||||
|
declare module "diagnostics_channel" {
|
||||||
|
import { AsyncLocalStorage } from "node:async_hooks";
|
||||||
|
/**
|
||||||
|
* Check if there are active subscribers to the named channel. This is helpful if
|
||||||
|
* the message you want to send might be expensive to prepare.
|
||||||
|
*
|
||||||
|
* This API is optional but helpful when trying to publish messages from very
|
||||||
|
* performance-sensitive code.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* if (diagnostics_channel.hasSubscribers('my-channel')) {
|
||||||
|
* // There are subscribers, prepare and publish message
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
* @param name The channel name
|
||||||
|
* @return If there are active subscribers
|
||||||
|
*/
|
||||||
|
function hasSubscribers(name: string | symbol): boolean;
|
||||||
|
/**
|
||||||
|
* This is the primary entry-point for anyone wanting to publish to a named
|
||||||
|
* channel. It produces a channel object which is optimized to reduce overhead at
|
||||||
|
* publish time as much as possible.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channel = diagnostics_channel.channel('my-channel');
|
||||||
|
* ```
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
* @param name The channel name
|
||||||
|
* @return The named channel object
|
||||||
|
*/
|
||||||
|
function channel(name: string | symbol): Channel;
|
||||||
|
type ChannelListener = (message: unknown, name: string | symbol) => void;
|
||||||
|
/**
|
||||||
|
* Register a message handler to subscribe to this channel. This message handler
|
||||||
|
* will be run synchronously whenever a message is published to the channel. Any
|
||||||
|
* errors thrown in the message handler will trigger an `'uncaughtException'`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* diagnostics_channel.subscribe('my-channel', (message, name) => {
|
||||||
|
* // Received data
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v18.7.0, v16.17.0
|
||||||
|
* @param name The channel name
|
||||||
|
* @param onMessage The handler to receive channel messages
|
||||||
|
*/
|
||||||
|
function subscribe(name: string | symbol, onMessage: ChannelListener): void;
|
||||||
|
/**
|
||||||
|
* Remove a message handler previously registered to this channel with {@link subscribe}.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* function onMessage(message, name) {
|
||||||
|
* // Received data
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* diagnostics_channel.subscribe('my-channel', onMessage);
|
||||||
|
*
|
||||||
|
* diagnostics_channel.unsubscribe('my-channel', onMessage);
|
||||||
|
* ```
|
||||||
|
* @since v18.7.0, v16.17.0
|
||||||
|
* @param name The channel name
|
||||||
|
* @param onMessage The previous subscribed handler to remove
|
||||||
|
* @return `true` if the handler was found, `false` otherwise.
|
||||||
|
*/
|
||||||
|
function unsubscribe(name: string | symbol, onMessage: ChannelListener): boolean;
|
||||||
|
/**
|
||||||
|
* Creates a `TracingChannel` wrapper for the given `TracingChannel Channels`. If a name is given, the corresponding tracing
|
||||||
|
* channels will be created in the form of `tracing:${name}:${eventType}` where `eventType` corresponds to the types of `TracingChannel Channels`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channelsByName = diagnostics_channel.tracingChannel('my-channel');
|
||||||
|
*
|
||||||
|
* // or...
|
||||||
|
*
|
||||||
|
* const channelsByCollection = diagnostics_channel.tracingChannel({
|
||||||
|
* start: diagnostics_channel.channel('tracing:my-channel:start'),
|
||||||
|
* end: diagnostics_channel.channel('tracing:my-channel:end'),
|
||||||
|
* asyncStart: diagnostics_channel.channel('tracing:my-channel:asyncStart'),
|
||||||
|
* asyncEnd: diagnostics_channel.channel('tracing:my-channel:asyncEnd'),
|
||||||
|
* error: diagnostics_channel.channel('tracing:my-channel:error'),
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param nameOrChannels Channel name or object containing all the `TracingChannel Channels`
|
||||||
|
* @return Collection of channels to trace with
|
||||||
|
*/
|
||||||
|
function tracingChannel<
|
||||||
|
StoreType = unknown,
|
||||||
|
ContextType extends object = StoreType extends object ? StoreType : object,
|
||||||
|
>(
|
||||||
|
nameOrChannels: string | TracingChannelCollection<StoreType, ContextType>,
|
||||||
|
): TracingChannel<StoreType, ContextType>;
|
||||||
|
/**
|
||||||
|
* The class `Channel` represents an individual named channel within the data
|
||||||
|
* pipeline. It is used to track subscribers and to publish messages when there
|
||||||
|
* are subscribers present. It exists as a separate object to avoid channel
|
||||||
|
* lookups at publish time, enabling very fast publish speeds and allowing
|
||||||
|
* for heavy use while incurring very minimal cost. Channels are created with {@link channel}, constructing a channel directly
|
||||||
|
* with `new Channel(name)` is not supported.
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
*/
|
||||||
|
class Channel<StoreType = unknown, ContextType = StoreType> {
|
||||||
|
readonly name: string | symbol;
|
||||||
|
/**
|
||||||
|
* Check if there are active subscribers to this channel. This is helpful if
|
||||||
|
* the message you want to send might be expensive to prepare.
|
||||||
|
*
|
||||||
|
* This API is optional but helpful when trying to publish messages from very
|
||||||
|
* performance-sensitive code.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channel = diagnostics_channel.channel('my-channel');
|
||||||
|
*
|
||||||
|
* if (channel.hasSubscribers) {
|
||||||
|
* // There are subscribers, prepare and publish message
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
*/
|
||||||
|
readonly hasSubscribers: boolean;
|
||||||
|
private constructor(name: string | symbol);
|
||||||
|
/**
|
||||||
|
* Publish a message to any subscribers to the channel. This will trigger
|
||||||
|
* message handlers synchronously so they will execute within the same context.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channel = diagnostics_channel.channel('my-channel');
|
||||||
|
*
|
||||||
|
* channel.publish({
|
||||||
|
* some: 'message',
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
* @param message The message to send to the channel subscribers
|
||||||
|
*/
|
||||||
|
publish(message: unknown): void;
|
||||||
|
/**
|
||||||
|
* Register a message handler to subscribe to this channel. This message handler
|
||||||
|
* will be run synchronously whenever a message is published to the channel. Any
|
||||||
|
* errors thrown in the message handler will trigger an `'uncaughtException'`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channel = diagnostics_channel.channel('my-channel');
|
||||||
|
*
|
||||||
|
* channel.subscribe((message, name) => {
|
||||||
|
* // Received data
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
* @deprecated Since v18.7.0,v16.17.0 - Use {@link subscribe(name, onMessage)}
|
||||||
|
* @param onMessage The handler to receive channel messages
|
||||||
|
*/
|
||||||
|
subscribe(onMessage: ChannelListener): void;
|
||||||
|
/**
|
||||||
|
* Remove a message handler previously registered to this channel with `channel.subscribe(onMessage)`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channel = diagnostics_channel.channel('my-channel');
|
||||||
|
*
|
||||||
|
* function onMessage(message, name) {
|
||||||
|
* // Received data
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* channel.subscribe(onMessage);
|
||||||
|
*
|
||||||
|
* channel.unsubscribe(onMessage);
|
||||||
|
* ```
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
* @deprecated Since v18.7.0,v16.17.0 - Use {@link unsubscribe(name, onMessage)}
|
||||||
|
* @param onMessage The previous subscribed handler to remove
|
||||||
|
* @return `true` if the handler was found, `false` otherwise.
|
||||||
|
*/
|
||||||
|
unsubscribe(onMessage: ChannelListener): void;
|
||||||
|
/**
|
||||||
|
* When `channel.runStores(context, ...)` is called, the given context data
|
||||||
|
* will be applied to any store bound to the channel. If the store has already been
|
||||||
|
* bound the previous `transform` function will be replaced with the new one.
|
||||||
|
* The `transform` function may be omitted to set the given context data as the
|
||||||
|
* context directly.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
* import { AsyncLocalStorage } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* const store = new AsyncLocalStorage();
|
||||||
|
*
|
||||||
|
* const channel = diagnostics_channel.channel('my-channel');
|
||||||
|
*
|
||||||
|
* channel.bindStore(store, (data) => {
|
||||||
|
* return { data };
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param store The store to which to bind the context data
|
||||||
|
* @param transform Transform context data before setting the store context
|
||||||
|
*/
|
||||||
|
bindStore(store: AsyncLocalStorage<StoreType>, transform?: (context: ContextType) => StoreType): void;
|
||||||
|
/**
|
||||||
|
* Remove a message handler previously registered to this channel with `channel.bindStore(store)`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
* import { AsyncLocalStorage } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* const store = new AsyncLocalStorage();
|
||||||
|
*
|
||||||
|
* const channel = diagnostics_channel.channel('my-channel');
|
||||||
|
*
|
||||||
|
* channel.bindStore(store);
|
||||||
|
* channel.unbindStore(store);
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param store The store to unbind from the channel.
|
||||||
|
* @return `true` if the store was found, `false` otherwise.
|
||||||
|
*/
|
||||||
|
unbindStore(store: AsyncLocalStorage<StoreType>): boolean;
|
||||||
|
/**
|
||||||
|
* Applies the given data to any AsyncLocalStorage instances bound to the channel
|
||||||
|
* for the duration of the given function, then publishes to the channel within
|
||||||
|
* the scope of that data is applied to the stores.
|
||||||
|
*
|
||||||
|
* If a transform function was given to `channel.bindStore(store)` it will be
|
||||||
|
* applied to transform the message data before it becomes the context value for
|
||||||
|
* the store. The prior storage context is accessible from within the transform
|
||||||
|
* function in cases where context linking is required.
|
||||||
|
*
|
||||||
|
* The context applied to the store should be accessible in any async code which
|
||||||
|
* continues from execution which began during the given function, however
|
||||||
|
* there are some situations in which `context loss` may occur.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
* import { AsyncLocalStorage } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* const store = new AsyncLocalStorage();
|
||||||
|
*
|
||||||
|
* const channel = diagnostics_channel.channel('my-channel');
|
||||||
|
*
|
||||||
|
* channel.bindStore(store, (message) => {
|
||||||
|
* const parent = store.getStore();
|
||||||
|
* return new Span(message, parent);
|
||||||
|
* });
|
||||||
|
* channel.runStores({ some: 'message' }, () => {
|
||||||
|
* store.getStore(); // Span({ some: 'message' })
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param context Message to send to subscribers and bind to stores
|
||||||
|
* @param fn Handler to run within the entered storage context
|
||||||
|
* @param thisArg The receiver to be used for the function call.
|
||||||
|
* @param args Optional arguments to pass to the function.
|
||||||
|
*/
|
||||||
|
runStores<ThisArg = any, Args extends any[] = any[], Result = any>(
|
||||||
|
context: ContextType,
|
||||||
|
fn: (this: ThisArg, ...args: Args) => Result,
|
||||||
|
thisArg?: ThisArg,
|
||||||
|
...args: Args
|
||||||
|
): Result;
|
||||||
|
}
|
||||||
|
interface TracingChannelSubscribers<ContextType extends object> {
|
||||||
|
start: (message: ContextType) => void;
|
||||||
|
end: (
|
||||||
|
message: ContextType & {
|
||||||
|
error?: unknown;
|
||||||
|
result?: unknown;
|
||||||
|
},
|
||||||
|
) => void;
|
||||||
|
asyncStart: (
|
||||||
|
message: ContextType & {
|
||||||
|
error?: unknown;
|
||||||
|
result?: unknown;
|
||||||
|
},
|
||||||
|
) => void;
|
||||||
|
asyncEnd: (
|
||||||
|
message: ContextType & {
|
||||||
|
error?: unknown;
|
||||||
|
result?: unknown;
|
||||||
|
},
|
||||||
|
) => void;
|
||||||
|
error: (
|
||||||
|
message: ContextType & {
|
||||||
|
error: unknown;
|
||||||
|
},
|
||||||
|
) => void;
|
||||||
|
}
|
||||||
|
interface TracingChannelCollection<StoreType = unknown, ContextType = StoreType> {
|
||||||
|
start: Channel<StoreType, ContextType>;
|
||||||
|
end: Channel<StoreType, ContextType>;
|
||||||
|
asyncStart: Channel<StoreType, ContextType>;
|
||||||
|
asyncEnd: Channel<StoreType, ContextType>;
|
||||||
|
error: Channel<StoreType, ContextType>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The class `TracingChannel` is a collection of `TracingChannel Channels` which
|
||||||
|
* together express a single traceable action. It is used to formalize and
|
||||||
|
* simplify the process of producing events for tracing application flow. {@link tracingChannel} is used to construct a `TracingChannel`. As with `Channel` it is recommended to create and reuse a
|
||||||
|
* single `TracingChannel` at the top-level of the file rather than creating them
|
||||||
|
* dynamically.
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
*/
|
||||||
|
class TracingChannel<StoreType = unknown, ContextType extends object = {}> implements TracingChannelCollection {
|
||||||
|
start: Channel<StoreType, ContextType>;
|
||||||
|
end: Channel<StoreType, ContextType>;
|
||||||
|
asyncStart: Channel<StoreType, ContextType>;
|
||||||
|
asyncEnd: Channel<StoreType, ContextType>;
|
||||||
|
error: Channel<StoreType, ContextType>;
|
||||||
|
/**
|
||||||
|
* Helper to subscribe a collection of functions to the corresponding channels.
|
||||||
|
* This is the same as calling `channel.subscribe(onMessage)` on each channel
|
||||||
|
* individually.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channels = diagnostics_channel.tracingChannel('my-channel');
|
||||||
|
*
|
||||||
|
* channels.subscribe({
|
||||||
|
* start(message) {
|
||||||
|
* // Handle start message
|
||||||
|
* },
|
||||||
|
* end(message) {
|
||||||
|
* // Handle end message
|
||||||
|
* },
|
||||||
|
* asyncStart(message) {
|
||||||
|
* // Handle asyncStart message
|
||||||
|
* },
|
||||||
|
* asyncEnd(message) {
|
||||||
|
* // Handle asyncEnd message
|
||||||
|
* },
|
||||||
|
* error(message) {
|
||||||
|
* // Handle error message
|
||||||
|
* },
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param subscribers Set of `TracingChannel Channels` subscribers
|
||||||
|
*/
|
||||||
|
subscribe(subscribers: TracingChannelSubscribers<ContextType>): void;
|
||||||
|
/**
|
||||||
|
* Helper to unsubscribe a collection of functions from the corresponding channels.
|
||||||
|
* This is the same as calling `channel.unsubscribe(onMessage)` on each channel
|
||||||
|
* individually.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channels = diagnostics_channel.tracingChannel('my-channel');
|
||||||
|
*
|
||||||
|
* channels.unsubscribe({
|
||||||
|
* start(message) {
|
||||||
|
* // Handle start message
|
||||||
|
* },
|
||||||
|
* end(message) {
|
||||||
|
* // Handle end message
|
||||||
|
* },
|
||||||
|
* asyncStart(message) {
|
||||||
|
* // Handle asyncStart message
|
||||||
|
* },
|
||||||
|
* asyncEnd(message) {
|
||||||
|
* // Handle asyncEnd message
|
||||||
|
* },
|
||||||
|
* error(message) {
|
||||||
|
* // Handle error message
|
||||||
|
* },
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param subscribers Set of `TracingChannel Channels` subscribers
|
||||||
|
* @return `true` if all handlers were successfully unsubscribed, and `false` otherwise.
|
||||||
|
*/
|
||||||
|
unsubscribe(subscribers: TracingChannelSubscribers<ContextType>): void;
|
||||||
|
/**
|
||||||
|
* Trace a synchronous function call. This will always produce a `start event` and `end event` around the execution and may produce an `error event` if the given function throws an error.
|
||||||
|
* This will run the given function using `channel.runStores(context, ...)` on the `start` channel which ensures all
|
||||||
|
* events should have any bound stores set to match this trace context.
|
||||||
|
*
|
||||||
|
* To ensure only correct trace graphs are formed, events will only be published if subscribers are present prior to starting the trace. Subscriptions
|
||||||
|
* which are added after the trace begins will not receive future events from that trace, only future traces will be seen.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channels = diagnostics_channel.tracingChannel('my-channel');
|
||||||
|
*
|
||||||
|
* channels.traceSync(() => {
|
||||||
|
* // Do something
|
||||||
|
* }, {
|
||||||
|
* some: 'thing',
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param fn Function to wrap a trace around
|
||||||
|
* @param context Shared object to correlate events through
|
||||||
|
* @param thisArg The receiver to be used for the function call
|
||||||
|
* @param args Optional arguments to pass to the function
|
||||||
|
* @return The return value of the given function
|
||||||
|
*/
|
||||||
|
traceSync<ThisArg = any, Args extends any[] = any[], Result = any>(
|
||||||
|
fn: (this: ThisArg, ...args: Args) => Result,
|
||||||
|
context?: ContextType,
|
||||||
|
thisArg?: ThisArg,
|
||||||
|
...args: Args
|
||||||
|
): Result;
|
||||||
|
/**
|
||||||
|
* Trace a promise-returning function call. This will always produce a `start event` and `end event` around the synchronous portion of the
|
||||||
|
* function execution, and will produce an `asyncStart event` and `asyncEnd event` when a promise continuation is reached. It may also
|
||||||
|
* produce an `error event` if the given function throws an error or the
|
||||||
|
* returned promise rejects. This will run the given function using `channel.runStores(context, ...)` on the `start` channel which ensures all
|
||||||
|
* events should have any bound stores set to match this trace context.
|
||||||
|
*
|
||||||
|
* To ensure only correct trace graphs are formed, events will only be published if subscribers are present prior to starting the trace. Subscriptions
|
||||||
|
* which are added after the trace begins will not receive future events from that trace, only future traces will be seen.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channels = diagnostics_channel.tracingChannel('my-channel');
|
||||||
|
*
|
||||||
|
* channels.tracePromise(async () => {
|
||||||
|
* // Do something
|
||||||
|
* }, {
|
||||||
|
* some: 'thing',
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param fn Promise-returning function to wrap a trace around
|
||||||
|
* @param context Shared object to correlate trace events through
|
||||||
|
* @param thisArg The receiver to be used for the function call
|
||||||
|
* @param args Optional arguments to pass to the function
|
||||||
|
* @return Chained from promise returned by the given function
|
||||||
|
*/
|
||||||
|
tracePromise<ThisArg = any, Args extends any[] = any[], Result = any>(
|
||||||
|
fn: (this: ThisArg, ...args: Args) => Promise<Result>,
|
||||||
|
context?: ContextType,
|
||||||
|
thisArg?: ThisArg,
|
||||||
|
...args: Args
|
||||||
|
): Promise<Result>;
|
||||||
|
/**
|
||||||
|
* Trace a callback-receiving function call. This will always produce a `start event` and `end event` around the synchronous portion of the
|
||||||
|
* function execution, and will produce a `asyncStart event` and `asyncEnd event` around the callback execution. It may also produce an `error event` if the given function throws an error or
|
||||||
|
* the returned
|
||||||
|
* promise rejects. This will run the given function using `channel.runStores(context, ...)` on the `start` channel which ensures all
|
||||||
|
* events should have any bound stores set to match this trace context.
|
||||||
|
*
|
||||||
|
* The `position` will be -1 by default to indicate the final argument should
|
||||||
|
* be used as the callback.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
*
|
||||||
|
* const channels = diagnostics_channel.tracingChannel('my-channel');
|
||||||
|
*
|
||||||
|
* channels.traceCallback((arg1, callback) => {
|
||||||
|
* // Do something
|
||||||
|
* callback(null, 'result');
|
||||||
|
* }, 1, {
|
||||||
|
* some: 'thing',
|
||||||
|
* }, thisArg, arg1, callback);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The callback will also be run with `channel.runStores(context, ...)` which
|
||||||
|
* enables context loss recovery in some cases.
|
||||||
|
*
|
||||||
|
* To ensure only correct trace graphs are formed, events will only be published if subscribers are present prior to starting the trace. Subscriptions
|
||||||
|
* which are added after the trace begins will not receive future events from that trace, only future traces will be seen.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import diagnostics_channel from 'node:diagnostics_channel';
|
||||||
|
* import { AsyncLocalStorage } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* const channels = diagnostics_channel.tracingChannel('my-channel');
|
||||||
|
* const myStore = new AsyncLocalStorage();
|
||||||
|
*
|
||||||
|
* // The start channel sets the initial store data to something
|
||||||
|
* // and stores that store data value on the trace context object
|
||||||
|
* channels.start.bindStore(myStore, (data) => {
|
||||||
|
* const span = new Span(data);
|
||||||
|
* data.span = span;
|
||||||
|
* return span;
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* // Then asyncStart can restore from that data it stored previously
|
||||||
|
* channels.asyncStart.bindStore(myStore, (data) => {
|
||||||
|
* return data.span;
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
* @experimental
|
||||||
|
* @param fn callback using function to wrap a trace around
|
||||||
|
* @param position Zero-indexed argument position of expected callback
|
||||||
|
* @param context Shared object to correlate trace events through
|
||||||
|
* @param thisArg The receiver to be used for the function call
|
||||||
|
* @param args Optional arguments to pass to the function
|
||||||
|
* @return The return value of the given function
|
||||||
|
*/
|
||||||
|
traceCallback<ThisArg = any, Args extends any[] = any[], Result = any>(
|
||||||
|
fn: (this: ThisArg, ...args: Args) => Result,
|
||||||
|
position?: number,
|
||||||
|
context?: ContextType,
|
||||||
|
thisArg?: ThisArg,
|
||||||
|
...args: Args
|
||||||
|
): Result;
|
||||||
|
/**
|
||||||
|
* `true` if any of the individual channels has a subscriber, `false` if not.
|
||||||
|
*
|
||||||
|
* This is a helper method available on a {@link TracingChannel} instance to check
|
||||||
|
* if any of the [TracingChannel Channels](https://nodejs.org/api/diagnostics_channel.html#tracingchannel-channels) have subscribers.
|
||||||
|
* A `true` is returned if any of them have at least one subscriber, a `false` is returned otherwise.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const diagnostics_channel = require('node:diagnostics_channel');
|
||||||
|
*
|
||||||
|
* const channels = diagnostics_channel.tracingChannel('my-channel');
|
||||||
|
*
|
||||||
|
* if (channels.hasSubscribers) {
|
||||||
|
* // Do something
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v22.0.0, v20.13.0
|
||||||
|
*/
|
||||||
|
readonly hasSubscribers: boolean;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
declare module "node:diagnostics_channel" {
|
||||||
|
export * from "diagnostics_channel";
|
||||||
|
}
|
||||||
+871
@@ -0,0 +1,871 @@
|
|||||||
|
/**
|
||||||
|
* The `node:dns` module enables name resolution. For example, use it to look up IP
|
||||||
|
* addresses of host names.
|
||||||
|
*
|
||||||
|
* Although named for the [Domain Name System (DNS)](https://en.wikipedia.org/wiki/Domain_Name_System), it does not always use the
|
||||||
|
* DNS protocol for lookups. {@link lookup} uses the operating system
|
||||||
|
* facilities to perform name resolution. It may not need to perform any network
|
||||||
|
* communication. To perform name resolution the way other applications on the same
|
||||||
|
* system do, use {@link lookup}.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dns from 'node:dns';
|
||||||
|
*
|
||||||
|
* dns.lookup('example.org', (err, address, family) => {
|
||||||
|
* console.log('address: %j family: IPv%s', address, family);
|
||||||
|
* });
|
||||||
|
* // address: "93.184.216.34" family: IPv4
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* All other functions in the `node:dns` module connect to an actual DNS server to
|
||||||
|
* perform name resolution. They will always use the network to perform DNS
|
||||||
|
* queries. These functions do not use the same set of configuration files used by {@link lookup} (e.g. `/etc/hosts`). Use these functions to always perform
|
||||||
|
* DNS queries, bypassing other name-resolution facilities.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dns from 'node:dns';
|
||||||
|
*
|
||||||
|
* dns.resolve4('archive.org', (err, addresses) => {
|
||||||
|
* if (err) throw err;
|
||||||
|
*
|
||||||
|
* console.log(`addresses: ${JSON.stringify(addresses)}`);
|
||||||
|
*
|
||||||
|
* addresses.forEach((a) => {
|
||||||
|
* dns.reverse(a, (err, hostnames) => {
|
||||||
|
* if (err) {
|
||||||
|
* throw err;
|
||||||
|
* }
|
||||||
|
* console.log(`reverse for ${a}: ${JSON.stringify(hostnames)}`);
|
||||||
|
* });
|
||||||
|
* });
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* See the [Implementation considerations section](https://nodejs.org/docs/latest-v20.x/api/dns.html#implementation-considerations) for more information.
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/dns.js)
|
||||||
|
*/
|
||||||
|
declare module "dns" {
|
||||||
|
import * as dnsPromises from "node:dns/promises";
|
||||||
|
// Supported getaddrinfo flags.
|
||||||
|
/**
|
||||||
|
* Limits returned address types to the types of non-loopback addresses configured on the system. For example, IPv4 addresses are
|
||||||
|
* only returned if the current system has at least one IPv4 address configured.
|
||||||
|
*/
|
||||||
|
export const ADDRCONFIG: number;
|
||||||
|
/**
|
||||||
|
* If the IPv6 family was specified, but no IPv6 addresses were found, then return IPv4 mapped IPv6 addresses. It is not supported
|
||||||
|
* on some operating systems (e.g. FreeBSD 10.1).
|
||||||
|
*/
|
||||||
|
export const V4MAPPED: number;
|
||||||
|
/**
|
||||||
|
* If `dns.V4MAPPED` is specified, return resolved IPv6 addresses as
|
||||||
|
* well as IPv4 mapped IPv6 addresses.
|
||||||
|
*/
|
||||||
|
export const ALL: number;
|
||||||
|
export interface LookupOptions {
|
||||||
|
/**
|
||||||
|
* The record family. Must be `4`, `6`, or `0`. For backward compatibility reasons, `'IPv4'` and `'IPv6'` are interpreted
|
||||||
|
* as `4` and `6` respectively. The value 0 indicates that either an IPv4 or IPv6 address is returned. If the value `0` is used
|
||||||
|
* with `{ all: true } (see below)`, both IPv4 and IPv6 addresses are returned.
|
||||||
|
* @default 0
|
||||||
|
*/
|
||||||
|
family?: number | "IPv4" | "IPv6" | undefined;
|
||||||
|
/**
|
||||||
|
* One or more [supported `getaddrinfo`](https://nodejs.org/docs/latest-v20.x/api/dns.html#supported-getaddrinfo-flags) flags. Multiple flags may be
|
||||||
|
* passed by bitwise `OR`ing their values.
|
||||||
|
*/
|
||||||
|
hints?: number | undefined;
|
||||||
|
/**
|
||||||
|
* When `true`, the callback returns all resolved addresses in an array. Otherwise, returns a single address.
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
all?: boolean | undefined;
|
||||||
|
/**
|
||||||
|
* When `verbatim`, the resolved addresses are return unsorted. When `ipv4first`, the resolved addresses are sorted
|
||||||
|
* by placing IPv4 addresses before IPv6 addresses. When `ipv6first`, the resolved addresses are sorted by placing IPv6
|
||||||
|
* addresses before IPv4 addresses. Default value is configurable using
|
||||||
|
* {@link setDefaultResultOrder} or [`--dns-result-order`](https://nodejs.org/docs/latest-v20.x/api/cli.html#--dns-result-orderorder).
|
||||||
|
* @default `verbatim` (addresses are not reordered)
|
||||||
|
*/
|
||||||
|
order?: "ipv4first" | "ipv6first" | "verbatim" | undefined;
|
||||||
|
/**
|
||||||
|
* When `true`, the callback receives IPv4 and IPv6 addresses in the order the DNS resolver returned them. When `false`, IPv4
|
||||||
|
* addresses are placed before IPv6 addresses. This option will be deprecated in favor of `order`. When both are specified,
|
||||||
|
* `order` has higher precedence. New code should only use `order`. Default value is configurable using {@link setDefaultResultOrder}
|
||||||
|
* or [`--dns-result-order`](https://nodejs.org/docs/latest-v20.x/api/cli.html#--dns-result-orderorder).
|
||||||
|
* @default true (addresses are not reordered)
|
||||||
|
*/
|
||||||
|
verbatim?: boolean | undefined;
|
||||||
|
}
|
||||||
|
export interface LookupOneOptions extends LookupOptions {
|
||||||
|
all?: false | undefined;
|
||||||
|
}
|
||||||
|
export interface LookupAllOptions extends LookupOptions {
|
||||||
|
all: true;
|
||||||
|
}
|
||||||
|
export interface LookupAddress {
|
||||||
|
/**
|
||||||
|
* A string representation of an IPv4 or IPv6 address.
|
||||||
|
*/
|
||||||
|
address: string;
|
||||||
|
/**
|
||||||
|
* `4` or `6`, denoting the family of `address`, or `0` if the address is not an IPv4 or IPv6 address. `0` is a likely indicator of a
|
||||||
|
* bug in the name resolution service used by the operating system.
|
||||||
|
*/
|
||||||
|
family: number;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Resolves a host name (e.g. `'nodejs.org'`) into the first found A (IPv4) or
|
||||||
|
* AAAA (IPv6) record. All `option` properties are optional. If `options` is an
|
||||||
|
* integer, then it must be `4` or `6` – if `options` is `0` or not provided, then
|
||||||
|
* IPv4 and IPv6 addresses are both returned if found.
|
||||||
|
*
|
||||||
|
* With the `all` option set to `true`, the arguments for `callback` change to `(err, addresses)`, with `addresses` being an array of objects with the
|
||||||
|
* properties `address` and `family`.
|
||||||
|
*
|
||||||
|
* On error, `err` is an `Error` object, where `err.code` is the error code.
|
||||||
|
* Keep in mind that `err.code` will be set to `'ENOTFOUND'` not only when
|
||||||
|
* the host name does not exist but also when the lookup fails in other ways
|
||||||
|
* such as no available file descriptors.
|
||||||
|
*
|
||||||
|
* `dns.lookup()` does not necessarily have anything to do with the DNS protocol.
|
||||||
|
* The implementation uses an operating system facility that can associate names
|
||||||
|
* with addresses and vice versa. This implementation can have subtle but
|
||||||
|
* important consequences on the behavior of any Node.js program. Please take some
|
||||||
|
* time to consult the [Implementation considerations section](https://nodejs.org/docs/latest-v20.x/api/dns.html#implementation-considerations)
|
||||||
|
* before using `dns.lookup()`.
|
||||||
|
*
|
||||||
|
* Example usage:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dns from 'node:dns';
|
||||||
|
* const options = {
|
||||||
|
* family: 6,
|
||||||
|
* hints: dns.ADDRCONFIG | dns.V4MAPPED,
|
||||||
|
* };
|
||||||
|
* dns.lookup('example.com', options, (err, address, family) =>
|
||||||
|
* console.log('address: %j family: IPv%s', address, family));
|
||||||
|
* // address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6
|
||||||
|
*
|
||||||
|
* // When options.all is true, the result will be an Array.
|
||||||
|
* options.all = true;
|
||||||
|
* dns.lookup('example.com', options, (err, addresses) =>
|
||||||
|
* console.log('addresses: %j', addresses));
|
||||||
|
* // addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}]
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* If this method is invoked as its [util.promisify()](https://nodejs.org/docs/latest-v20.x/api/util.html#utilpromisifyoriginal) ed
|
||||||
|
* version, and `all` is not set to `true`, it returns a `Promise` for an `Object` with `address` and `family` properties.
|
||||||
|
* @since v0.1.90
|
||||||
|
*/
|
||||||
|
export function lookup(
|
||||||
|
hostname: string,
|
||||||
|
family: number,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void,
|
||||||
|
): void;
|
||||||
|
export function lookup(
|
||||||
|
hostname: string,
|
||||||
|
options: LookupOneOptions,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void,
|
||||||
|
): void;
|
||||||
|
export function lookup(
|
||||||
|
hostname: string,
|
||||||
|
options: LookupAllOptions,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: LookupAddress[]) => void,
|
||||||
|
): void;
|
||||||
|
export function lookup(
|
||||||
|
hostname: string,
|
||||||
|
options: LookupOptions,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, address: string | LookupAddress[], family: number) => void,
|
||||||
|
): void;
|
||||||
|
export function lookup(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void,
|
||||||
|
): void;
|
||||||
|
export namespace lookup {
|
||||||
|
function __promisify__(hostname: string, options: LookupAllOptions): Promise<LookupAddress[]>;
|
||||||
|
function __promisify__(hostname: string, options?: LookupOneOptions | number): Promise<LookupAddress>;
|
||||||
|
function __promisify__(hostname: string, options: LookupOptions): Promise<LookupAddress | LookupAddress[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Resolves the given `address` and `port` into a host name and service using
|
||||||
|
* the operating system's underlying `getnameinfo` implementation.
|
||||||
|
*
|
||||||
|
* If `address` is not a valid IP address, a `TypeError` will be thrown.
|
||||||
|
* The `port` will be coerced to a number. If it is not a legal port, a `TypeError` will be thrown.
|
||||||
|
*
|
||||||
|
* On an error, `err` is an [`Error`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-error) object,
|
||||||
|
* where `err.code` is the error code.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dns from 'node:dns';
|
||||||
|
* dns.lookupService('127.0.0.1', 22, (err, hostname, service) => {
|
||||||
|
* console.log(hostname, service);
|
||||||
|
* // Prints: localhost ssh
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* If this method is invoked as its [util.promisify()](https://nodejs.org/docs/latest-v20.x/api/util.html#utilpromisifyoriginal) ed
|
||||||
|
* version, it returns a `Promise` for an `Object` with `hostname` and `service` properties.
|
||||||
|
* @since v0.11.14
|
||||||
|
*/
|
||||||
|
export function lookupService(
|
||||||
|
address: string,
|
||||||
|
port: number,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, hostname: string, service: string) => void,
|
||||||
|
): void;
|
||||||
|
export namespace lookupService {
|
||||||
|
function __promisify__(
|
||||||
|
address: string,
|
||||||
|
port: number,
|
||||||
|
): Promise<{
|
||||||
|
hostname: string;
|
||||||
|
service: string;
|
||||||
|
}>;
|
||||||
|
}
|
||||||
|
export interface ResolveOptions {
|
||||||
|
ttl: boolean;
|
||||||
|
}
|
||||||
|
export interface ResolveWithTtlOptions extends ResolveOptions {
|
||||||
|
ttl: true;
|
||||||
|
}
|
||||||
|
export interface RecordWithTtl {
|
||||||
|
address: string;
|
||||||
|
ttl: number;
|
||||||
|
}
|
||||||
|
/** @deprecated Use `AnyARecord` or `AnyAaaaRecord` instead. */
|
||||||
|
export type AnyRecordWithTtl = AnyARecord | AnyAaaaRecord;
|
||||||
|
export interface AnyARecord extends RecordWithTtl {
|
||||||
|
type: "A";
|
||||||
|
}
|
||||||
|
export interface AnyAaaaRecord extends RecordWithTtl {
|
||||||
|
type: "AAAA";
|
||||||
|
}
|
||||||
|
export interface CaaRecord {
|
||||||
|
critical: number;
|
||||||
|
issue?: string | undefined;
|
||||||
|
issuewild?: string | undefined;
|
||||||
|
iodef?: string | undefined;
|
||||||
|
contactemail?: string | undefined;
|
||||||
|
contactphone?: string | undefined;
|
||||||
|
}
|
||||||
|
export interface AnyCaaRecord extends CaaRecord {
|
||||||
|
type: "CAA";
|
||||||
|
}
|
||||||
|
export interface MxRecord {
|
||||||
|
priority: number;
|
||||||
|
exchange: string;
|
||||||
|
}
|
||||||
|
export interface AnyMxRecord extends MxRecord {
|
||||||
|
type: "MX";
|
||||||
|
}
|
||||||
|
export interface NaptrRecord {
|
||||||
|
flags: string;
|
||||||
|
service: string;
|
||||||
|
regexp: string;
|
||||||
|
replacement: string;
|
||||||
|
order: number;
|
||||||
|
preference: number;
|
||||||
|
}
|
||||||
|
export interface AnyNaptrRecord extends NaptrRecord {
|
||||||
|
type: "NAPTR";
|
||||||
|
}
|
||||||
|
export interface SoaRecord {
|
||||||
|
nsname: string;
|
||||||
|
hostmaster: string;
|
||||||
|
serial: number;
|
||||||
|
refresh: number;
|
||||||
|
retry: number;
|
||||||
|
expire: number;
|
||||||
|
minttl: number;
|
||||||
|
}
|
||||||
|
export interface AnySoaRecord extends SoaRecord {
|
||||||
|
type: "SOA";
|
||||||
|
}
|
||||||
|
export interface SrvRecord {
|
||||||
|
priority: number;
|
||||||
|
weight: number;
|
||||||
|
port: number;
|
||||||
|
name: string;
|
||||||
|
}
|
||||||
|
export interface AnySrvRecord extends SrvRecord {
|
||||||
|
type: "SRV";
|
||||||
|
}
|
||||||
|
export interface AnyTxtRecord {
|
||||||
|
type: "TXT";
|
||||||
|
entries: string[];
|
||||||
|
}
|
||||||
|
export interface AnyNsRecord {
|
||||||
|
type: "NS";
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
export interface AnyPtrRecord {
|
||||||
|
type: "PTR";
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
export interface AnyCnameRecord {
|
||||||
|
type: "CNAME";
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
export type AnyRecord =
|
||||||
|
| AnyARecord
|
||||||
|
| AnyAaaaRecord
|
||||||
|
| AnyCaaRecord
|
||||||
|
| AnyCnameRecord
|
||||||
|
| AnyMxRecord
|
||||||
|
| AnyNaptrRecord
|
||||||
|
| AnyNsRecord
|
||||||
|
| AnyPtrRecord
|
||||||
|
| AnySoaRecord
|
||||||
|
| AnySrvRecord
|
||||||
|
| AnyTxtRecord;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve a host name (e.g. `'nodejs.org'`) into an array
|
||||||
|
* of the resource records. The `callback` function has arguments `(err, records)`. When successful, `records` will be an array of resource
|
||||||
|
* records. The type and structure of individual results varies based on `rrtype`:
|
||||||
|
*
|
||||||
|
* <omitted>
|
||||||
|
*
|
||||||
|
* On error, `err` is an [`Error`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-error) object,
|
||||||
|
* where `err.code` is one of the `DNS error codes`.
|
||||||
|
* @since v0.1.27
|
||||||
|
* @param hostname Host name to resolve.
|
||||||
|
* @param [rrtype='A'] Resource record type.
|
||||||
|
*/
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: "A" | "AAAA" | "CNAME" | "NS" | "PTR",
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: "ANY",
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: AnyRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: "CAA",
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, address: CaaRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: "MX",
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: MxRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: "NAPTR",
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: NaptrRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: "SOA",
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: SoaRecord) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: "SRV",
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: SrvRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: "TXT",
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[][]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: string,
|
||||||
|
callback: (
|
||||||
|
err: NodeJS.ErrnoException | null,
|
||||||
|
addresses:
|
||||||
|
| string[]
|
||||||
|
| CaaRecord[]
|
||||||
|
| MxRecord[]
|
||||||
|
| NaptrRecord[]
|
||||||
|
| SoaRecord
|
||||||
|
| SrvRecord[]
|
||||||
|
| string[][]
|
||||||
|
| AnyRecord[],
|
||||||
|
) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolve {
|
||||||
|
function __promisify__(hostname: string, rrtype?: "A" | "AAAA" | "CNAME" | "NS" | "PTR"): Promise<string[]>;
|
||||||
|
function __promisify__(hostname: string, rrtype: "ANY"): Promise<AnyRecord[]>;
|
||||||
|
function __promisify__(hostname: string, rrtype: "CAA"): Promise<CaaRecord[]>;
|
||||||
|
function __promisify__(hostname: string, rrtype: "MX"): Promise<MxRecord[]>;
|
||||||
|
function __promisify__(hostname: string, rrtype: "NAPTR"): Promise<NaptrRecord[]>;
|
||||||
|
function __promisify__(hostname: string, rrtype: "SOA"): Promise<SoaRecord>;
|
||||||
|
function __promisify__(hostname: string, rrtype: "SRV"): Promise<SrvRecord[]>;
|
||||||
|
function __promisify__(hostname: string, rrtype: "TXT"): Promise<string[][]>;
|
||||||
|
function __promisify__(
|
||||||
|
hostname: string,
|
||||||
|
rrtype: string,
|
||||||
|
): Promise<
|
||||||
|
| string[]
|
||||||
|
| CaaRecord[]
|
||||||
|
| MxRecord[]
|
||||||
|
| NaptrRecord[]
|
||||||
|
| SoaRecord
|
||||||
|
| SrvRecord[]
|
||||||
|
| string[][]
|
||||||
|
| AnyRecord[]
|
||||||
|
>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve a IPv4 addresses (`A` records) for the `hostname`. The `addresses` argument passed to the `callback` function
|
||||||
|
* will contain an array of IPv4 addresses (e.g.`['74.125.79.104', '74.125.79.105', '74.125.79.106']`).
|
||||||
|
* @since v0.1.16
|
||||||
|
* @param hostname Host name to resolve.
|
||||||
|
*/
|
||||||
|
export function resolve4(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve4(
|
||||||
|
hostname: string,
|
||||||
|
options: ResolveWithTtlOptions,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: RecordWithTtl[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve4(
|
||||||
|
hostname: string,
|
||||||
|
options: ResolveOptions,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[] | RecordWithTtl[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolve4 {
|
||||||
|
function __promisify__(hostname: string): Promise<string[]>;
|
||||||
|
function __promisify__(hostname: string, options: ResolveWithTtlOptions): Promise<RecordWithTtl[]>;
|
||||||
|
function __promisify__(hostname: string, options?: ResolveOptions): Promise<string[] | RecordWithTtl[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve IPv6 addresses (`AAAA` records) for the `hostname`. The `addresses` argument passed to the `callback` function
|
||||||
|
* will contain an array of IPv6 addresses.
|
||||||
|
* @since v0.1.16
|
||||||
|
* @param hostname Host name to resolve.
|
||||||
|
*/
|
||||||
|
export function resolve6(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve6(
|
||||||
|
hostname: string,
|
||||||
|
options: ResolveWithTtlOptions,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: RecordWithTtl[]) => void,
|
||||||
|
): void;
|
||||||
|
export function resolve6(
|
||||||
|
hostname: string,
|
||||||
|
options: ResolveOptions,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[] | RecordWithTtl[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolve6 {
|
||||||
|
function __promisify__(hostname: string): Promise<string[]>;
|
||||||
|
function __promisify__(hostname: string, options: ResolveWithTtlOptions): Promise<RecordWithTtl[]>;
|
||||||
|
function __promisify__(hostname: string, options?: ResolveOptions): Promise<string[] | RecordWithTtl[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve `CNAME` records for the `hostname`. The `addresses` argument passed to the `callback` function
|
||||||
|
* will contain an array of canonical name records available for the `hostname` (e.g. `['bar.example.com']`).
|
||||||
|
* @since v0.3.2
|
||||||
|
*/
|
||||||
|
export function resolveCname(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveCname {
|
||||||
|
function __promisify__(hostname: string): Promise<string[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve `CAA` records for the `hostname`. The `addresses` argument passed to the `callback` function
|
||||||
|
* will contain an array of certification authority authorization records
|
||||||
|
* available for the `hostname` (e.g. `[{critical: 0, iodef: 'mailto:pki@example.com'}, {critical: 128, issue: 'pki.example.com'}]`).
|
||||||
|
* @since v15.0.0, v14.17.0
|
||||||
|
*/
|
||||||
|
export function resolveCaa(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, records: CaaRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveCaa {
|
||||||
|
function __promisify__(hostname: string): Promise<CaaRecord[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve mail exchange records (`MX` records) for the `hostname`. The `addresses` argument passed to the `callback` function will
|
||||||
|
* contain an array of objects containing both a `priority` and `exchange` property (e.g. `[{priority: 10, exchange: 'mx.example.com'}, ...]`).
|
||||||
|
* @since v0.1.27
|
||||||
|
*/
|
||||||
|
export function resolveMx(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: MxRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveMx {
|
||||||
|
function __promisify__(hostname: string): Promise<MxRecord[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve regular expression-based records (`NAPTR` records) for the `hostname`. The `addresses` argument passed to the `callback` function will contain an array of
|
||||||
|
* objects with the following properties:
|
||||||
|
*
|
||||||
|
* * `flags`
|
||||||
|
* * `service`
|
||||||
|
* * `regexp`
|
||||||
|
* * `replacement`
|
||||||
|
* * `order`
|
||||||
|
* * `preference`
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* {
|
||||||
|
* flags: 's',
|
||||||
|
* service: 'SIP+D2U',
|
||||||
|
* regexp: '',
|
||||||
|
* replacement: '_sip._udp.example.com',
|
||||||
|
* order: 30,
|
||||||
|
* preference: 100
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.9.12
|
||||||
|
*/
|
||||||
|
export function resolveNaptr(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: NaptrRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveNaptr {
|
||||||
|
function __promisify__(hostname: string): Promise<NaptrRecord[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve name server records (`NS` records) for the `hostname`. The `addresses` argument passed to the `callback` function will
|
||||||
|
* contain an array of name server records available for `hostname` (e.g. `['ns1.example.com', 'ns2.example.com']`).
|
||||||
|
* @since v0.1.90
|
||||||
|
*/
|
||||||
|
export function resolveNs(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveNs {
|
||||||
|
function __promisify__(hostname: string): Promise<string[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve pointer records (`PTR` records) for the `hostname`. The `addresses` argument passed to the `callback` function will
|
||||||
|
* be an array of strings containing the reply records.
|
||||||
|
* @since v6.0.0
|
||||||
|
*/
|
||||||
|
export function resolvePtr(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolvePtr {
|
||||||
|
function __promisify__(hostname: string): Promise<string[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve a start of authority record (`SOA` record) for
|
||||||
|
* the `hostname`. The `address` argument passed to the `callback` function will
|
||||||
|
* be an object with the following properties:
|
||||||
|
*
|
||||||
|
* * `nsname`
|
||||||
|
* * `hostmaster`
|
||||||
|
* * `serial`
|
||||||
|
* * `refresh`
|
||||||
|
* * `retry`
|
||||||
|
* * `expire`
|
||||||
|
* * `minttl`
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* {
|
||||||
|
* nsname: 'ns.example.com',
|
||||||
|
* hostmaster: 'root.example.com',
|
||||||
|
* serial: 2013101809,
|
||||||
|
* refresh: 10000,
|
||||||
|
* retry: 2400,
|
||||||
|
* expire: 604800,
|
||||||
|
* minttl: 3600
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.11.10
|
||||||
|
*/
|
||||||
|
export function resolveSoa(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, address: SoaRecord) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveSoa {
|
||||||
|
function __promisify__(hostname: string): Promise<SoaRecord>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve service records (`SRV` records) for the `hostname`. The `addresses` argument passed to the `callback` function will
|
||||||
|
* be an array of objects with the following properties:
|
||||||
|
*
|
||||||
|
* * `priority`
|
||||||
|
* * `weight`
|
||||||
|
* * `port`
|
||||||
|
* * `name`
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* {
|
||||||
|
* priority: 10,
|
||||||
|
* weight: 5,
|
||||||
|
* port: 21223,
|
||||||
|
* name: 'service.example.com'
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.1.27
|
||||||
|
*/
|
||||||
|
export function resolveSrv(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: SrvRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveSrv {
|
||||||
|
function __promisify__(hostname: string): Promise<SrvRecord[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve text queries (`TXT` records) for the `hostname`. The `records` argument passed to the `callback` function is a
|
||||||
|
* two-dimensional array of the text records available for `hostname` (e.g.`[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]`). Each sub-array contains TXT chunks of
|
||||||
|
* one record. Depending on the use case, these could be either joined together or
|
||||||
|
* treated separately.
|
||||||
|
* @since v0.1.27
|
||||||
|
*/
|
||||||
|
export function resolveTxt(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: string[][]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveTxt {
|
||||||
|
function __promisify__(hostname: string): Promise<string[][]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve all records (also known as `ANY` or `*` query).
|
||||||
|
* The `ret` argument passed to the `callback` function will be an array containing
|
||||||
|
* various types of records. Each object has a property `type` that indicates the
|
||||||
|
* type of the current record. And depending on the `type`, additional properties
|
||||||
|
* will be present on the object:
|
||||||
|
*
|
||||||
|
* <omitted>
|
||||||
|
*
|
||||||
|
* Here is an example of the `ret` object passed to the callback:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* [ { type: 'A', address: '127.0.0.1', ttl: 299 },
|
||||||
|
* { type: 'CNAME', value: 'example.com' },
|
||||||
|
* { type: 'MX', exchange: 'alt4.aspmx.l.example.com', priority: 50 },
|
||||||
|
* { type: 'NS', value: 'ns1.example.com' },
|
||||||
|
* { type: 'TXT', entries: [ 'v=spf1 include:_spf.example.com ~all' ] },
|
||||||
|
* { type: 'SOA',
|
||||||
|
* nsname: 'ns1.example.com',
|
||||||
|
* hostmaster: 'admin.example.com',
|
||||||
|
* serial: 156696742,
|
||||||
|
* refresh: 900,
|
||||||
|
* retry: 900,
|
||||||
|
* expire: 1800,
|
||||||
|
* minttl: 60 } ]
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* DNS server operators may choose not to respond to `ANY` queries. It may be better to call individual methods like {@link resolve4}, {@link resolveMx}, and so on. For more details, see
|
||||||
|
* [RFC 8482](https://tools.ietf.org/html/rfc8482).
|
||||||
|
*/
|
||||||
|
export function resolveAny(
|
||||||
|
hostname: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, addresses: AnyRecord[]) => void,
|
||||||
|
): void;
|
||||||
|
export namespace resolveAny {
|
||||||
|
function __promisify__(hostname: string): Promise<AnyRecord[]>;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an
|
||||||
|
* array of host names.
|
||||||
|
*
|
||||||
|
* On error, `err` is an [`Error`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-error) object, where `err.code` is
|
||||||
|
* one of the [DNS error codes](https://nodejs.org/docs/latest-v20.x/api/dns.html#error-codes).
|
||||||
|
* @since v0.1.16
|
||||||
|
*/
|
||||||
|
export function reverse(
|
||||||
|
ip: string,
|
||||||
|
callback: (err: NodeJS.ErrnoException | null, hostnames: string[]) => void,
|
||||||
|
): void;
|
||||||
|
/**
|
||||||
|
* Get the default value for `order` in {@link lookup} and [`dnsPromises.lookup()`](https://nodejs.org/docs/latest-v20.x/api/dns.html#dnspromiseslookuphostname-options).
|
||||||
|
* The value could be:
|
||||||
|
*
|
||||||
|
* * `ipv4first`: for `order` defaulting to `ipv4first`.
|
||||||
|
* * `ipv6first`: for `order` defaulting to `ipv6first`.
|
||||||
|
* * `verbatim`: for `order` defaulting to `verbatim`.
|
||||||
|
* @since v18.17.0
|
||||||
|
*/
|
||||||
|
export function getDefaultResultOrder(): "ipv4first" | "ipv6first" | "verbatim";
|
||||||
|
/**
|
||||||
|
* Sets the IP address and port of servers to be used when performing DNS
|
||||||
|
* resolution. The `servers` argument is an array of [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6) formatted
|
||||||
|
* addresses. If the port is the IANA default DNS port (53) it can be omitted.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* dns.setServers([
|
||||||
|
* '4.4.4.4',
|
||||||
|
* '[2001:4860:4860::8888]',
|
||||||
|
* '4.4.4.4:1053',
|
||||||
|
* '[2001:4860:4860::8888]:1053',
|
||||||
|
* ]);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* An error will be thrown if an invalid address is provided.
|
||||||
|
*
|
||||||
|
* The `dns.setServers()` method must not be called while a DNS query is in
|
||||||
|
* progress.
|
||||||
|
*
|
||||||
|
* The {@link setServers} method affects only {@link resolve}, `dns.resolve*()` and {@link reverse} (and specifically _not_ {@link lookup}).
|
||||||
|
*
|
||||||
|
* This method works much like [resolve.conf](https://man7.org/linux/man-pages/man5/resolv.conf.5.html).
|
||||||
|
* That is, if attempting to resolve with the first server provided results in a `NOTFOUND` error, the `resolve()` method will _not_ attempt to resolve with
|
||||||
|
* subsequent servers provided. Fallback DNS servers will only be used if the
|
||||||
|
* earlier ones time out or result in some other error.
|
||||||
|
* @since v0.11.3
|
||||||
|
* @param servers array of [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952#section-6) formatted addresses
|
||||||
|
*/
|
||||||
|
export function setServers(servers: readonly string[]): void;
|
||||||
|
/**
|
||||||
|
* Returns an array of IP address strings, formatted according to [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6),
|
||||||
|
* that are currently configured for DNS resolution. A string will include a port
|
||||||
|
* section if a custom port is used.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* [
|
||||||
|
* '4.4.4.4',
|
||||||
|
* '2001:4860:4860::8888',
|
||||||
|
* '4.4.4.4:1053',
|
||||||
|
* '[2001:4860:4860::8888]:1053',
|
||||||
|
* ]
|
||||||
|
* ```
|
||||||
|
* @since v0.11.3
|
||||||
|
*/
|
||||||
|
export function getServers(): string[];
|
||||||
|
/**
|
||||||
|
* Set the default value of `order` in {@link lookup} and [`dnsPromises.lookup()`](https://nodejs.org/docs/latest-v20.x/api/dns.html#dnspromiseslookuphostname-options).
|
||||||
|
* The value could be:
|
||||||
|
*
|
||||||
|
* * `ipv4first`: sets default `order` to `ipv4first`.
|
||||||
|
* * `ipv6first`: sets default `order` to `ipv6first`.
|
||||||
|
* * `verbatim`: sets default `order` to `verbatim`.
|
||||||
|
*
|
||||||
|
* The default is `verbatim` and {@link setDefaultResultOrder} have higher
|
||||||
|
* priority than [`--dns-result-order`](https://nodejs.org/docs/latest-v20.x/api/cli.html#--dns-result-orderorder). When using
|
||||||
|
* [worker threads](https://nodejs.org/docs/latest-v20.x/api/worker_threads.html), {@link setDefaultResultOrder} from the main
|
||||||
|
* thread won't affect the default dns orders in workers.
|
||||||
|
* @since v16.4.0, v14.18.0
|
||||||
|
* @param order must be `'ipv4first'`, `'ipv6first'` or `'verbatim'`.
|
||||||
|
*/
|
||||||
|
export function setDefaultResultOrder(order: "ipv4first" | "ipv6first" | "verbatim"): void;
|
||||||
|
// Error codes
|
||||||
|
export const NODATA: "ENODATA";
|
||||||
|
export const FORMERR: "EFORMERR";
|
||||||
|
export const SERVFAIL: "ESERVFAIL";
|
||||||
|
export const NOTFOUND: "ENOTFOUND";
|
||||||
|
export const NOTIMP: "ENOTIMP";
|
||||||
|
export const REFUSED: "EREFUSED";
|
||||||
|
export const BADQUERY: "EBADQUERY";
|
||||||
|
export const BADNAME: "EBADNAME";
|
||||||
|
export const BADFAMILY: "EBADFAMILY";
|
||||||
|
export const BADRESP: "EBADRESP";
|
||||||
|
export const CONNREFUSED: "ECONNREFUSED";
|
||||||
|
export const TIMEOUT: "ETIMEOUT";
|
||||||
|
export const EOF: "EOF";
|
||||||
|
export const FILE: "EFILE";
|
||||||
|
export const NOMEM: "ENOMEM";
|
||||||
|
export const DESTRUCTION: "EDESTRUCTION";
|
||||||
|
export const BADSTR: "EBADSTR";
|
||||||
|
export const BADFLAGS: "EBADFLAGS";
|
||||||
|
export const NONAME: "ENONAME";
|
||||||
|
export const BADHINTS: "EBADHINTS";
|
||||||
|
export const NOTINITIALIZED: "ENOTINITIALIZED";
|
||||||
|
export const LOADIPHLPAPI: "ELOADIPHLPAPI";
|
||||||
|
export const ADDRGETNETWORKPARAMS: "EADDRGETNETWORKPARAMS";
|
||||||
|
export const CANCELLED: "ECANCELLED";
|
||||||
|
export interface ResolverOptions {
|
||||||
|
/**
|
||||||
|
* Query timeout in milliseconds, or `-1` to use the default timeout.
|
||||||
|
*/
|
||||||
|
timeout?: number | undefined;
|
||||||
|
/**
|
||||||
|
* The number of tries the resolver will try contacting each name server before giving up.
|
||||||
|
* @default 4
|
||||||
|
*/
|
||||||
|
tries?: number | undefined;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* An independent resolver for DNS requests.
|
||||||
|
*
|
||||||
|
* Creating a new resolver uses the default server settings. Setting
|
||||||
|
* the servers used for a resolver using [`resolver.setServers()`](https://nodejs.org/docs/latest-v20.x/api/dns.html#dnssetserversservers) does not affect
|
||||||
|
* other resolvers:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { Resolver } from 'node:dns';
|
||||||
|
* const resolver = new Resolver();
|
||||||
|
* resolver.setServers(['4.4.4.4']);
|
||||||
|
*
|
||||||
|
* // This request will use the server at 4.4.4.4, independent of global settings.
|
||||||
|
* resolver.resolve4('example.org', (err, addresses) => {
|
||||||
|
* // ...
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The following methods from the `node:dns` module are available:
|
||||||
|
*
|
||||||
|
* * `resolver.getServers()`
|
||||||
|
* * `resolver.resolve()`
|
||||||
|
* * `resolver.resolve4()`
|
||||||
|
* * `resolver.resolve6()`
|
||||||
|
* * `resolver.resolveAny()`
|
||||||
|
* * `resolver.resolveCaa()`
|
||||||
|
* * `resolver.resolveCname()`
|
||||||
|
* * `resolver.resolveMx()`
|
||||||
|
* * `resolver.resolveNaptr()`
|
||||||
|
* * `resolver.resolveNs()`
|
||||||
|
* * `resolver.resolvePtr()`
|
||||||
|
* * `resolver.resolveSoa()`
|
||||||
|
* * `resolver.resolveSrv()`
|
||||||
|
* * `resolver.resolveTxt()`
|
||||||
|
* * `resolver.reverse()`
|
||||||
|
* * `resolver.setServers()`
|
||||||
|
* @since v8.3.0
|
||||||
|
*/
|
||||||
|
export class Resolver {
|
||||||
|
constructor(options?: ResolverOptions);
|
||||||
|
/**
|
||||||
|
* Cancel all outstanding DNS queries made by this resolver. The corresponding
|
||||||
|
* callbacks will be called with an error with code `ECANCELLED`.
|
||||||
|
* @since v8.3.0
|
||||||
|
*/
|
||||||
|
cancel(): void;
|
||||||
|
getServers: typeof getServers;
|
||||||
|
resolve: typeof resolve;
|
||||||
|
resolve4: typeof resolve4;
|
||||||
|
resolve6: typeof resolve6;
|
||||||
|
resolveAny: typeof resolveAny;
|
||||||
|
resolveCaa: typeof resolveCaa;
|
||||||
|
resolveCname: typeof resolveCname;
|
||||||
|
resolveMx: typeof resolveMx;
|
||||||
|
resolveNaptr: typeof resolveNaptr;
|
||||||
|
resolveNs: typeof resolveNs;
|
||||||
|
resolvePtr: typeof resolvePtr;
|
||||||
|
resolveSoa: typeof resolveSoa;
|
||||||
|
resolveSrv: typeof resolveSrv;
|
||||||
|
resolveTxt: typeof resolveTxt;
|
||||||
|
reverse: typeof reverse;
|
||||||
|
/**
|
||||||
|
* The resolver instance will send its requests from the specified IP address.
|
||||||
|
* This allows programs to specify outbound interfaces when used on multi-homed
|
||||||
|
* systems.
|
||||||
|
*
|
||||||
|
* If a v4 or v6 address is not specified, it is set to the default and the
|
||||||
|
* operating system will choose a local address automatically.
|
||||||
|
*
|
||||||
|
* The resolver will use the v4 local address when making requests to IPv4 DNS
|
||||||
|
* servers, and the v6 local address when making requests to IPv6 DNS servers.
|
||||||
|
* The `rrtype` of resolution requests has no impact on the local address used.
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
* @param [ipv4='0.0.0.0'] A string representation of an IPv4 address.
|
||||||
|
* @param [ipv6='::0'] A string representation of an IPv6 address.
|
||||||
|
*/
|
||||||
|
setLocalAddress(ipv4?: string, ipv6?: string): void;
|
||||||
|
setServers: typeof setServers;
|
||||||
|
}
|
||||||
|
export { dnsPromises as promises };
|
||||||
|
}
|
||||||
|
declare module "node:dns" {
|
||||||
|
export * from "dns";
|
||||||
|
}
|
||||||
+479
@@ -0,0 +1,479 @@
|
|||||||
|
/**
|
||||||
|
* The `dns.promises` API provides an alternative set of asynchronous DNS methods
|
||||||
|
* that return `Promise` objects rather than using callbacks. The API is accessible
|
||||||
|
* via `import { promises } from 'node:dns'` or `import dnsPromises from 'node:dns/promises'`.
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
declare module "dns/promises" {
|
||||||
|
import {
|
||||||
|
AnyRecord,
|
||||||
|
CaaRecord,
|
||||||
|
LookupAddress,
|
||||||
|
LookupAllOptions,
|
||||||
|
LookupOneOptions,
|
||||||
|
LookupOptions,
|
||||||
|
MxRecord,
|
||||||
|
NaptrRecord,
|
||||||
|
RecordWithTtl,
|
||||||
|
ResolveOptions,
|
||||||
|
ResolverOptions,
|
||||||
|
ResolveWithTtlOptions,
|
||||||
|
SoaRecord,
|
||||||
|
SrvRecord,
|
||||||
|
} from "node:dns";
|
||||||
|
/**
|
||||||
|
* Returns an array of IP address strings, formatted according to [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6),
|
||||||
|
* that are currently configured for DNS resolution. A string will include a port
|
||||||
|
* section if a custom port is used.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* [
|
||||||
|
* '4.4.4.4',
|
||||||
|
* '2001:4860:4860::8888',
|
||||||
|
* '4.4.4.4:1053',
|
||||||
|
* '[2001:4860:4860::8888]:1053',
|
||||||
|
* ]
|
||||||
|
* ```
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function getServers(): string[];
|
||||||
|
/**
|
||||||
|
* Resolves a host name (e.g. `'nodejs.org'`) into the first found A (IPv4) or
|
||||||
|
* AAAA (IPv6) record. All `option` properties are optional. If `options` is an
|
||||||
|
* integer, then it must be `4` or `6` – if `options` is not provided, then IPv4
|
||||||
|
* and IPv6 addresses are both returned if found.
|
||||||
|
*
|
||||||
|
* With the `all` option set to `true`, the `Promise` is resolved with `addresses` being an array of objects with the properties `address` and `family`.
|
||||||
|
*
|
||||||
|
* On error, the `Promise` is rejected with an [`Error`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-error) object, where `err.code` is the error code.
|
||||||
|
* Keep in mind that `err.code` will be set to `'ENOTFOUND'` not only when
|
||||||
|
* the host name does not exist but also when the lookup fails in other ways
|
||||||
|
* such as no available file descriptors.
|
||||||
|
*
|
||||||
|
* [`dnsPromises.lookup()`](https://nodejs.org/docs/latest-v20.x/api/dns.html#dnspromiseslookuphostname-options) does not necessarily have anything to do with the DNS
|
||||||
|
* protocol. The implementation uses an operating system facility that can
|
||||||
|
* associate names with addresses and vice versa. This implementation can have
|
||||||
|
* subtle but important consequences on the behavior of any Node.js program. Please
|
||||||
|
* take some time to consult the [Implementation considerations section](https://nodejs.org/docs/latest-v20.x/api/dns.html#implementation-considerations) before
|
||||||
|
* using `dnsPromises.lookup()`.
|
||||||
|
*
|
||||||
|
* Example usage:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dns from 'node:dns';
|
||||||
|
* const dnsPromises = dns.promises;
|
||||||
|
* const options = {
|
||||||
|
* family: 6,
|
||||||
|
* hints: dns.ADDRCONFIG | dns.V4MAPPED,
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* dnsPromises.lookup('example.com', options).then((result) => {
|
||||||
|
* console.log('address: %j family: IPv%s', result.address, result.family);
|
||||||
|
* // address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* // When options.all is true, the result will be an Array.
|
||||||
|
* options.all = true;
|
||||||
|
* dnsPromises.lookup('example.com', options).then((result) => {
|
||||||
|
* console.log('addresses: %j', result);
|
||||||
|
* // addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}]
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function lookup(hostname: string, family: number): Promise<LookupAddress>;
|
||||||
|
function lookup(hostname: string, options: LookupOneOptions): Promise<LookupAddress>;
|
||||||
|
function lookup(hostname: string, options: LookupAllOptions): Promise<LookupAddress[]>;
|
||||||
|
function lookup(hostname: string, options: LookupOptions): Promise<LookupAddress | LookupAddress[]>;
|
||||||
|
function lookup(hostname: string): Promise<LookupAddress>;
|
||||||
|
/**
|
||||||
|
* Resolves the given `address` and `port` into a host name and service using
|
||||||
|
* the operating system's underlying `getnameinfo` implementation.
|
||||||
|
*
|
||||||
|
* If `address` is not a valid IP address, a `TypeError` will be thrown.
|
||||||
|
* The `port` will be coerced to a number. If it is not a legal port, a `TypeError` will be thrown.
|
||||||
|
*
|
||||||
|
* On error, the `Promise` is rejected with an [`Error`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-error) object, where `err.code` is the error code.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dns from 'node:dns';
|
||||||
|
* dns.promises.lookupService('127.0.0.1', 22).then((result) => {
|
||||||
|
* console.log(result.hostname, result.service);
|
||||||
|
* // Prints: localhost ssh
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function lookupService(
|
||||||
|
address: string,
|
||||||
|
port: number,
|
||||||
|
): Promise<{
|
||||||
|
hostname: string;
|
||||||
|
service: string;
|
||||||
|
}>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve a host name (e.g. `'nodejs.org'`) into an array
|
||||||
|
* of the resource records. When successful, the `Promise` is resolved with an
|
||||||
|
* array of resource records. The type and structure of individual results vary
|
||||||
|
* based on `rrtype`:
|
||||||
|
*
|
||||||
|
* <omitted>
|
||||||
|
*
|
||||||
|
* On error, the `Promise` is rejected with an [`Error`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-error) object, where `err.code`
|
||||||
|
* is one of the [DNS error codes](https://nodejs.org/docs/latest-v20.x/api/dns.html#error-codes).
|
||||||
|
* @since v10.6.0
|
||||||
|
* @param hostname Host name to resolve.
|
||||||
|
* @param [rrtype='A'] Resource record type.
|
||||||
|
*/
|
||||||
|
function resolve(hostname: string): Promise<string[]>;
|
||||||
|
function resolve(hostname: string, rrtype: "A" | "AAAA" | "CNAME" | "NS" | "PTR"): Promise<string[]>;
|
||||||
|
function resolve(hostname: string, rrtype: "ANY"): Promise<AnyRecord[]>;
|
||||||
|
function resolve(hostname: string, rrtype: "CAA"): Promise<CaaRecord[]>;
|
||||||
|
function resolve(hostname: string, rrtype: "MX"): Promise<MxRecord[]>;
|
||||||
|
function resolve(hostname: string, rrtype: "NAPTR"): Promise<NaptrRecord[]>;
|
||||||
|
function resolve(hostname: string, rrtype: "SOA"): Promise<SoaRecord>;
|
||||||
|
function resolve(hostname: string, rrtype: "SRV"): Promise<SrvRecord[]>;
|
||||||
|
function resolve(hostname: string, rrtype: "TXT"): Promise<string[][]>;
|
||||||
|
function resolve(hostname: string, rrtype: string): Promise<
|
||||||
|
| string[]
|
||||||
|
| CaaRecord[]
|
||||||
|
| MxRecord[]
|
||||||
|
| NaptrRecord[]
|
||||||
|
| SoaRecord
|
||||||
|
| SrvRecord[]
|
||||||
|
| string[][]
|
||||||
|
| AnyRecord[]
|
||||||
|
>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve IPv4 addresses (`A` records) for the `hostname`. On success, the `Promise` is resolved with an array of IPv4
|
||||||
|
* addresses (e.g. `['74.125.79.104', '74.125.79.105', '74.125.79.106']`).
|
||||||
|
* @since v10.6.0
|
||||||
|
* @param hostname Host name to resolve.
|
||||||
|
*/
|
||||||
|
function resolve4(hostname: string): Promise<string[]>;
|
||||||
|
function resolve4(hostname: string, options: ResolveWithTtlOptions): Promise<RecordWithTtl[]>;
|
||||||
|
function resolve4(hostname: string, options: ResolveOptions): Promise<string[] | RecordWithTtl[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve IPv6 addresses (`AAAA` records) for the `hostname`. On success, the `Promise` is resolved with an array of IPv6
|
||||||
|
* addresses.
|
||||||
|
* @since v10.6.0
|
||||||
|
* @param hostname Host name to resolve.
|
||||||
|
*/
|
||||||
|
function resolve6(hostname: string): Promise<string[]>;
|
||||||
|
function resolve6(hostname: string, options: ResolveWithTtlOptions): Promise<RecordWithTtl[]>;
|
||||||
|
function resolve6(hostname: string, options: ResolveOptions): Promise<string[] | RecordWithTtl[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve all records (also known as `ANY` or `*` query).
|
||||||
|
* On success, the `Promise` is resolved with an array containing various types of
|
||||||
|
* records. Each object has a property `type` that indicates the type of the
|
||||||
|
* current record. And depending on the `type`, additional properties will be
|
||||||
|
* present on the object:
|
||||||
|
*
|
||||||
|
* <omitted>
|
||||||
|
*
|
||||||
|
* Here is an example of the result object:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* [ { type: 'A', address: '127.0.0.1', ttl: 299 },
|
||||||
|
* { type: 'CNAME', value: 'example.com' },
|
||||||
|
* { type: 'MX', exchange: 'alt4.aspmx.l.example.com', priority: 50 },
|
||||||
|
* { type: 'NS', value: 'ns1.example.com' },
|
||||||
|
* { type: 'TXT', entries: [ 'v=spf1 include:_spf.example.com ~all' ] },
|
||||||
|
* { type: 'SOA',
|
||||||
|
* nsname: 'ns1.example.com',
|
||||||
|
* hostmaster: 'admin.example.com',
|
||||||
|
* serial: 156696742,
|
||||||
|
* refresh: 900,
|
||||||
|
* retry: 900,
|
||||||
|
* expire: 1800,
|
||||||
|
* minttl: 60 } ]
|
||||||
|
* ```
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolveAny(hostname: string): Promise<AnyRecord[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve `CAA` records for the `hostname`. On success,
|
||||||
|
* the `Promise` is resolved with an array of objects containing available
|
||||||
|
* certification authority authorization records available for the `hostname` (e.g. `[{critical: 0, iodef: 'mailto:pki@example.com'},{critical: 128, issue: 'pki.example.com'}]`).
|
||||||
|
* @since v15.0.0, v14.17.0
|
||||||
|
*/
|
||||||
|
function resolveCaa(hostname: string): Promise<CaaRecord[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve `CNAME` records for the `hostname`. On success,
|
||||||
|
* the `Promise` is resolved with an array of canonical name records available for
|
||||||
|
* the `hostname` (e.g. `['bar.example.com']`).
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolveCname(hostname: string): Promise<string[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve mail exchange records (`MX` records) for the `hostname`. On success, the `Promise` is resolved with an array of objects
|
||||||
|
* containing both a `priority` and `exchange` property (e.g.`[{priority: 10, exchange: 'mx.example.com'}, ...]`).
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolveMx(hostname: string): Promise<MxRecord[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve regular expression-based records (`NAPTR` records) for the `hostname`. On success, the `Promise` is resolved with an array
|
||||||
|
* of objects with the following properties:
|
||||||
|
*
|
||||||
|
* * `flags`
|
||||||
|
* * `service`
|
||||||
|
* * `regexp`
|
||||||
|
* * `replacement`
|
||||||
|
* * `order`
|
||||||
|
* * `preference`
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* {
|
||||||
|
* flags: 's',
|
||||||
|
* service: 'SIP+D2U',
|
||||||
|
* regexp: '',
|
||||||
|
* replacement: '_sip._udp.example.com',
|
||||||
|
* order: 30,
|
||||||
|
* preference: 100
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolveNaptr(hostname: string): Promise<NaptrRecord[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve name server records (`NS` records) for the `hostname`. On success, the `Promise` is resolved with an array of name server
|
||||||
|
* records available for `hostname` (e.g.`['ns1.example.com', 'ns2.example.com']`).
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolveNs(hostname: string): Promise<string[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve pointer records (`PTR` records) for the `hostname`. On success, the `Promise` is resolved with an array of strings
|
||||||
|
* containing the reply records.
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolvePtr(hostname: string): Promise<string[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve a start of authority record (`SOA` record) for
|
||||||
|
* the `hostname`. On success, the `Promise` is resolved with an object with the
|
||||||
|
* following properties:
|
||||||
|
*
|
||||||
|
* * `nsname`
|
||||||
|
* * `hostmaster`
|
||||||
|
* * `serial`
|
||||||
|
* * `refresh`
|
||||||
|
* * `retry`
|
||||||
|
* * `expire`
|
||||||
|
* * `minttl`
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* {
|
||||||
|
* nsname: 'ns.example.com',
|
||||||
|
* hostmaster: 'root.example.com',
|
||||||
|
* serial: 2013101809,
|
||||||
|
* refresh: 10000,
|
||||||
|
* retry: 2400,
|
||||||
|
* expire: 604800,
|
||||||
|
* minttl: 3600
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolveSoa(hostname: string): Promise<SoaRecord>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve service records (`SRV` records) for the `hostname`. On success, the `Promise` is resolved with an array of objects with
|
||||||
|
* the following properties:
|
||||||
|
*
|
||||||
|
* * `priority`
|
||||||
|
* * `weight`
|
||||||
|
* * `port`
|
||||||
|
* * `name`
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* {
|
||||||
|
* priority: 10,
|
||||||
|
* weight: 5,
|
||||||
|
* port: 21223,
|
||||||
|
* name: 'service.example.com'
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolveSrv(hostname: string): Promise<SrvRecord[]>;
|
||||||
|
/**
|
||||||
|
* Uses the DNS protocol to resolve text queries (`TXT` records) for the `hostname`. On success, the `Promise` is resolved with a two-dimensional array
|
||||||
|
* of the text records available for `hostname` (e.g.`[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]`). Each sub-array contains TXT chunks of
|
||||||
|
* one record. Depending on the use case, these could be either joined together or
|
||||||
|
* treated separately.
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function resolveTxt(hostname: string): Promise<string[][]>;
|
||||||
|
/**
|
||||||
|
* Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an
|
||||||
|
* array of host names.
|
||||||
|
*
|
||||||
|
* On error, the `Promise` is rejected with an [`Error`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-error) object, where `err.code`
|
||||||
|
* is one of the [DNS error codes](https://nodejs.org/docs/latest-v20.x/api/dns.html#error-codes).
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
function reverse(ip: string): Promise<string[]>;
|
||||||
|
/**
|
||||||
|
* Get the default value for `verbatim` in {@link lookup} and [dnsPromises.lookup()](https://nodejs.org/docs/latest-v20.x/api/dns.html#dnspromiseslookuphostname-options).
|
||||||
|
* The value could be:
|
||||||
|
*
|
||||||
|
* * `ipv4first`: for `verbatim` defaulting to `false`.
|
||||||
|
* * `verbatim`: for `verbatim` defaulting to `true`.
|
||||||
|
* @since v20.1.0
|
||||||
|
*/
|
||||||
|
function getDefaultResultOrder(): "ipv4first" | "verbatim";
|
||||||
|
/**
|
||||||
|
* Sets the IP address and port of servers to be used when performing DNS
|
||||||
|
* resolution. The `servers` argument is an array of [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6) formatted
|
||||||
|
* addresses. If the port is the IANA default DNS port (53) it can be omitted.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* dnsPromises.setServers([
|
||||||
|
* '4.4.4.4',
|
||||||
|
* '[2001:4860:4860::8888]',
|
||||||
|
* '4.4.4.4:1053',
|
||||||
|
* '[2001:4860:4860::8888]:1053',
|
||||||
|
* ]);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* An error will be thrown if an invalid address is provided.
|
||||||
|
*
|
||||||
|
* The `dnsPromises.setServers()` method must not be called while a DNS query is in
|
||||||
|
* progress.
|
||||||
|
*
|
||||||
|
* This method works much like [resolve.conf](https://man7.org/linux/man-pages/man5/resolv.conf.5.html).
|
||||||
|
* That is, if attempting to resolve with the first server provided results in a `NOTFOUND` error, the `resolve()` method will _not_ attempt to resolve with
|
||||||
|
* subsequent servers provided. Fallback DNS servers will only be used if the
|
||||||
|
* earlier ones time out or result in some other error.
|
||||||
|
* @since v10.6.0
|
||||||
|
* @param servers array of `RFC 5952` formatted addresses
|
||||||
|
*/
|
||||||
|
function setServers(servers: readonly string[]): void;
|
||||||
|
/**
|
||||||
|
* Set the default value of `order` in `dns.lookup()` and `{@link lookup}`. The value could be:
|
||||||
|
*
|
||||||
|
* * `ipv4first`: sets default `order` to `ipv4first`.
|
||||||
|
* * `ipv6first`: sets default `order` to `ipv6first`.
|
||||||
|
* * `verbatim`: sets default `order` to `verbatim`.
|
||||||
|
*
|
||||||
|
* The default is `verbatim` and [dnsPromises.setDefaultResultOrder()](https://nodejs.org/docs/latest-v20.x/api/dns.html#dnspromisessetdefaultresultorderorder)
|
||||||
|
* have higher priority than [`--dns-result-order`](https://nodejs.org/docs/latest-v20.x/api/cli.html#--dns-result-orderorder).
|
||||||
|
* When using [worker threads](https://nodejs.org/docs/latest-v20.x/api/worker_threads.html), [`dnsPromises.setDefaultResultOrder()`](https://nodejs.org/docs/latest-v20.x/api/dns.html#dnspromisessetdefaultresultorderorder)
|
||||||
|
* from the main thread won't affect the default dns orders in workers.
|
||||||
|
* @since v16.4.0, v14.18.0
|
||||||
|
* @param order must be `'ipv4first'`, `'ipv6first'` or `'verbatim'`.
|
||||||
|
*/
|
||||||
|
function setDefaultResultOrder(order: "ipv4first" | "ipv6first" | "verbatim"): void;
|
||||||
|
// Error codes
|
||||||
|
const NODATA: "ENODATA";
|
||||||
|
const FORMERR: "EFORMERR";
|
||||||
|
const SERVFAIL: "ESERVFAIL";
|
||||||
|
const NOTFOUND: "ENOTFOUND";
|
||||||
|
const NOTIMP: "ENOTIMP";
|
||||||
|
const REFUSED: "EREFUSED";
|
||||||
|
const BADQUERY: "EBADQUERY";
|
||||||
|
const BADNAME: "EBADNAME";
|
||||||
|
const BADFAMILY: "EBADFAMILY";
|
||||||
|
const BADRESP: "EBADRESP";
|
||||||
|
const CONNREFUSED: "ECONNREFUSED";
|
||||||
|
const TIMEOUT: "ETIMEOUT";
|
||||||
|
const EOF: "EOF";
|
||||||
|
const FILE: "EFILE";
|
||||||
|
const NOMEM: "ENOMEM";
|
||||||
|
const DESTRUCTION: "EDESTRUCTION";
|
||||||
|
const BADSTR: "EBADSTR";
|
||||||
|
const BADFLAGS: "EBADFLAGS";
|
||||||
|
const NONAME: "ENONAME";
|
||||||
|
const BADHINTS: "EBADHINTS";
|
||||||
|
const NOTINITIALIZED: "ENOTINITIALIZED";
|
||||||
|
const LOADIPHLPAPI: "ELOADIPHLPAPI";
|
||||||
|
const ADDRGETNETWORKPARAMS: "EADDRGETNETWORKPARAMS";
|
||||||
|
const CANCELLED: "ECANCELLED";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An independent resolver for DNS requests.
|
||||||
|
*
|
||||||
|
* Creating a new resolver uses the default server settings. Setting
|
||||||
|
* the servers used for a resolver using [`resolver.setServers()`](https://nodejs.org/docs/latest-v20.x/api/dns.html#dnspromisessetserversservers) does not affect
|
||||||
|
* other resolvers:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import dns from 'node:dns';
|
||||||
|
* const { Resolver } = dns.promises;
|
||||||
|
* const resolver = new Resolver();
|
||||||
|
* resolver.setServers(['4.4.4.4']);
|
||||||
|
*
|
||||||
|
* // This request will use the server at 4.4.4.4, independent of global settings.
|
||||||
|
* resolver.resolve4('example.org').then((addresses) => {
|
||||||
|
* // ...
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* // Alternatively, the same code can be written using async-await style.
|
||||||
|
* (async function() {
|
||||||
|
* const addresses = await resolver.resolve4('example.org');
|
||||||
|
* })();
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The following methods from the `dnsPromises` API are available:
|
||||||
|
*
|
||||||
|
* * `resolver.getServers()`
|
||||||
|
* * `resolver.resolve()`
|
||||||
|
* * `resolver.resolve4()`
|
||||||
|
* * `resolver.resolve6()`
|
||||||
|
* * `resolver.resolveAny()`
|
||||||
|
* * `resolver.resolveCaa()`
|
||||||
|
* * `resolver.resolveCname()`
|
||||||
|
* * `resolver.resolveMx()`
|
||||||
|
* * `resolver.resolveNaptr()`
|
||||||
|
* * `resolver.resolveNs()`
|
||||||
|
* * `resolver.resolvePtr()`
|
||||||
|
* * `resolver.resolveSoa()`
|
||||||
|
* * `resolver.resolveSrv()`
|
||||||
|
* * `resolver.resolveTxt()`
|
||||||
|
* * `resolver.reverse()`
|
||||||
|
* * `resolver.setServers()`
|
||||||
|
* @since v10.6.0
|
||||||
|
*/
|
||||||
|
class Resolver {
|
||||||
|
constructor(options?: ResolverOptions);
|
||||||
|
/**
|
||||||
|
* Cancel all outstanding DNS queries made by this resolver. The corresponding
|
||||||
|
* callbacks will be called with an error with code `ECANCELLED`.
|
||||||
|
* @since v8.3.0
|
||||||
|
*/
|
||||||
|
cancel(): void;
|
||||||
|
getServers: typeof getServers;
|
||||||
|
resolve: typeof resolve;
|
||||||
|
resolve4: typeof resolve4;
|
||||||
|
resolve6: typeof resolve6;
|
||||||
|
resolveAny: typeof resolveAny;
|
||||||
|
resolveCaa: typeof resolveCaa;
|
||||||
|
resolveCname: typeof resolveCname;
|
||||||
|
resolveMx: typeof resolveMx;
|
||||||
|
resolveNaptr: typeof resolveNaptr;
|
||||||
|
resolveNs: typeof resolveNs;
|
||||||
|
resolvePtr: typeof resolvePtr;
|
||||||
|
resolveSoa: typeof resolveSoa;
|
||||||
|
resolveSrv: typeof resolveSrv;
|
||||||
|
resolveTxt: typeof resolveTxt;
|
||||||
|
reverse: typeof reverse;
|
||||||
|
/**
|
||||||
|
* The resolver instance will send its requests from the specified IP address.
|
||||||
|
* This allows programs to specify outbound interfaces when used on multi-homed
|
||||||
|
* systems.
|
||||||
|
*
|
||||||
|
* If a v4 or v6 address is not specified, it is set to the default and the
|
||||||
|
* operating system will choose a local address automatically.
|
||||||
|
*
|
||||||
|
* The resolver will use the v4 local address when making requests to IPv4 DNS
|
||||||
|
* servers, and the v6 local address when making requests to IPv6 DNS servers.
|
||||||
|
* The `rrtype` of resolution requests has no impact on the local address used.
|
||||||
|
* @since v15.1.0, v14.17.0
|
||||||
|
* @param [ipv4='0.0.0.0'] A string representation of an IPv4 address.
|
||||||
|
* @param [ipv6='::0'] A string representation of an IPv6 address.
|
||||||
|
*/
|
||||||
|
setLocalAddress(ipv4?: string, ipv6?: string): void;
|
||||||
|
setServers: typeof setServers;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
declare module "node:dns/promises" {
|
||||||
|
export * from "dns/promises";
|
||||||
|
}
|
||||||
+170
@@ -0,0 +1,170 @@
|
|||||||
|
/**
|
||||||
|
* **This module is pending deprecation.** Once a replacement API has been
|
||||||
|
* finalized, this module will be fully deprecated. Most developers should
|
||||||
|
* **not** have cause to use this module. Users who absolutely must have
|
||||||
|
* the functionality that domains provide may rely on it for the time being
|
||||||
|
* but should expect to have to migrate to a different solution
|
||||||
|
* in the future.
|
||||||
|
*
|
||||||
|
* Domains provide a way to handle multiple different IO operations as a
|
||||||
|
* single group. If any of the event emitters or callbacks registered to a
|
||||||
|
* domain emit an `'error'` event, or throw an error, then the domain object
|
||||||
|
* will be notified, rather than losing the context of the error in the `process.on('uncaughtException')` handler, or causing the program to
|
||||||
|
* exit immediately with an error code.
|
||||||
|
* @deprecated Since v1.4.2 - Deprecated
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/domain.js)
|
||||||
|
*/
|
||||||
|
declare module "domain" {
|
||||||
|
import EventEmitter = require("node:events");
|
||||||
|
/**
|
||||||
|
* The `Domain` class encapsulates the functionality of routing errors and
|
||||||
|
* uncaught exceptions to the active `Domain` object.
|
||||||
|
*
|
||||||
|
* To handle the errors that it catches, listen to its `'error'` event.
|
||||||
|
*/
|
||||||
|
class Domain extends EventEmitter {
|
||||||
|
/**
|
||||||
|
* An array of timers and event emitters that have been explicitly added
|
||||||
|
* to the domain.
|
||||||
|
*/
|
||||||
|
members: Array<EventEmitter | NodeJS.Timer>;
|
||||||
|
/**
|
||||||
|
* The `enter()` method is plumbing used by the `run()`, `bind()`, and `intercept()` methods to set the active domain. It sets `domain.active` and `process.domain` to the domain, and implicitly
|
||||||
|
* pushes the domain onto the domain
|
||||||
|
* stack managed by the domain module (see {@link exit} for details on the
|
||||||
|
* domain stack). The call to `enter()` delimits the beginning of a chain of
|
||||||
|
* asynchronous calls and I/O operations bound to a domain.
|
||||||
|
*
|
||||||
|
* Calling `enter()` changes only the active domain, and does not alter the domain
|
||||||
|
* itself. `enter()` and `exit()` can be called an arbitrary number of times on a
|
||||||
|
* single domain.
|
||||||
|
*/
|
||||||
|
enter(): void;
|
||||||
|
/**
|
||||||
|
* The `exit()` method exits the current domain, popping it off the domain stack.
|
||||||
|
* Any time execution is going to switch to the context of a different chain of
|
||||||
|
* asynchronous calls, it's important to ensure that the current domain is exited.
|
||||||
|
* The call to `exit()` delimits either the end of or an interruption to the chain
|
||||||
|
* of asynchronous calls and I/O operations bound to a domain.
|
||||||
|
*
|
||||||
|
* If there are multiple, nested domains bound to the current execution context, `exit()` will exit any domains nested within this domain.
|
||||||
|
*
|
||||||
|
* Calling `exit()` changes only the active domain, and does not alter the domain
|
||||||
|
* itself. `enter()` and `exit()` can be called an arbitrary number of times on a
|
||||||
|
* single domain.
|
||||||
|
*/
|
||||||
|
exit(): void;
|
||||||
|
/**
|
||||||
|
* Run the supplied function in the context of the domain, implicitly
|
||||||
|
* binding all event emitters, timers, and low-level requests that are
|
||||||
|
* created in that context. Optionally, arguments can be passed to
|
||||||
|
* the function.
|
||||||
|
*
|
||||||
|
* This is the most basic way to use a domain.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import domain from 'node:domain';
|
||||||
|
* import fs from 'node:fs';
|
||||||
|
* const d = domain.create();
|
||||||
|
* d.on('error', (er) => {
|
||||||
|
* console.error('Caught error!', er);
|
||||||
|
* });
|
||||||
|
* d.run(() => {
|
||||||
|
* process.nextTick(() => {
|
||||||
|
* setTimeout(() => { // Simulating some various async stuff
|
||||||
|
* fs.open('non-existent file', 'r', (er, fd) => {
|
||||||
|
* if (er) throw er;
|
||||||
|
* // proceed...
|
||||||
|
* });
|
||||||
|
* }, 100);
|
||||||
|
* });
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* In this example, the `d.on('error')` handler will be triggered, rather
|
||||||
|
* than crashing the program.
|
||||||
|
*/
|
||||||
|
run<T>(fn: (...args: any[]) => T, ...args: any[]): T;
|
||||||
|
/**
|
||||||
|
* Explicitly adds an emitter to the domain. If any event handlers called by
|
||||||
|
* the emitter throw an error, or if the emitter emits an `'error'` event, it
|
||||||
|
* will be routed to the domain's `'error'` event, just like with implicit
|
||||||
|
* binding.
|
||||||
|
*
|
||||||
|
* This also works with timers that are returned from `setInterval()` and `setTimeout()`. If their callback function throws, it will be caught by
|
||||||
|
* the domain `'error'` handler.
|
||||||
|
*
|
||||||
|
* If the Timer or `EventEmitter` was already bound to a domain, it is removed
|
||||||
|
* from that one, and bound to this one instead.
|
||||||
|
* @param emitter emitter or timer to be added to the domain
|
||||||
|
*/
|
||||||
|
add(emitter: EventEmitter | NodeJS.Timer): void;
|
||||||
|
/**
|
||||||
|
* The opposite of {@link add}. Removes domain handling from the
|
||||||
|
* specified emitter.
|
||||||
|
* @param emitter emitter or timer to be removed from the domain
|
||||||
|
*/
|
||||||
|
remove(emitter: EventEmitter | NodeJS.Timer): void;
|
||||||
|
/**
|
||||||
|
* The returned function will be a wrapper around the supplied callback
|
||||||
|
* function. When the returned function is called, any errors that are
|
||||||
|
* thrown will be routed to the domain's `'error'` event.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const d = domain.create();
|
||||||
|
*
|
||||||
|
* function readSomeFile(filename, cb) {
|
||||||
|
* fs.readFile(filename, 'utf8', d.bind((er, data) => {
|
||||||
|
* // If this throws, it will also be passed to the domain.
|
||||||
|
* return cb(er, data ? JSON.parse(data) : null);
|
||||||
|
* }));
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* d.on('error', (er) => {
|
||||||
|
* // An error occurred somewhere. If we throw it now, it will crash the program
|
||||||
|
* // with the normal line number and stack message.
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @param callback The callback function
|
||||||
|
* @return The bound function
|
||||||
|
*/
|
||||||
|
bind<T extends Function>(callback: T): T;
|
||||||
|
/**
|
||||||
|
* This method is almost identical to {@link bind}. However, in
|
||||||
|
* addition to catching thrown errors, it will also intercept `Error` objects sent as the first argument to the function.
|
||||||
|
*
|
||||||
|
* In this way, the common `if (err) return callback(err);` pattern can be replaced
|
||||||
|
* with a single error handler in a single place.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const d = domain.create();
|
||||||
|
*
|
||||||
|
* function readSomeFile(filename, cb) {
|
||||||
|
* fs.readFile(filename, 'utf8', d.intercept((data) => {
|
||||||
|
* // Note, the first argument is never passed to the
|
||||||
|
* // callback since it is assumed to be the 'Error' argument
|
||||||
|
* // and thus intercepted by the domain.
|
||||||
|
*
|
||||||
|
* // If this throws, it will also be passed to the domain
|
||||||
|
* // so the error-handling logic can be moved to the 'error'
|
||||||
|
* // event on the domain instead of being repeated throughout
|
||||||
|
* // the program.
|
||||||
|
* return cb(null, JSON.parse(data));
|
||||||
|
* }));
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* d.on('error', (er) => {
|
||||||
|
* // An error occurred somewhere. If we throw it now, it will crash the program
|
||||||
|
* // with the normal line number and stack message.
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @param callback The callback function
|
||||||
|
* @return The intercepted function
|
||||||
|
*/
|
||||||
|
intercept<T extends Function>(callback: T): T;
|
||||||
|
}
|
||||||
|
function create(): Domain;
|
||||||
|
}
|
||||||
|
declare module "node:domain" {
|
||||||
|
export * from "domain";
|
||||||
|
}
|
||||||
+977
@@ -0,0 +1,977 @@
|
|||||||
|
/**
|
||||||
|
* Much of the Node.js core API is built around an idiomatic asynchronous
|
||||||
|
* event-driven architecture in which certain kinds of objects (called "emitters")
|
||||||
|
* emit named events that cause `Function` objects ("listeners") to be called.
|
||||||
|
*
|
||||||
|
* For instance: a `net.Server` object emits an event each time a peer
|
||||||
|
* connects to it; a `fs.ReadStream` emits an event when the file is opened;
|
||||||
|
* a `stream` emits an event whenever data is available to be read.
|
||||||
|
*
|
||||||
|
* All objects that emit events are instances of the `EventEmitter` class. These
|
||||||
|
* objects expose an `eventEmitter.on()` function that allows one or more
|
||||||
|
* functions to be attached to named events emitted by the object. Typically,
|
||||||
|
* event names are camel-cased strings but any valid JavaScript property key
|
||||||
|
* can be used.
|
||||||
|
*
|
||||||
|
* When the `EventEmitter` object emits an event, all of the functions attached
|
||||||
|
* to that specific event are called _synchronously_. Any values returned by the
|
||||||
|
* called listeners are _ignored_ and discarded.
|
||||||
|
*
|
||||||
|
* The following example shows a simple `EventEmitter` instance with a single
|
||||||
|
* listener. The `eventEmitter.on()` method is used to register listeners, while
|
||||||
|
* the `eventEmitter.emit()` method is used to trigger the event.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
*
|
||||||
|
* class MyEmitter extends EventEmitter {}
|
||||||
|
*
|
||||||
|
* const myEmitter = new MyEmitter();
|
||||||
|
* myEmitter.on('event', () => {
|
||||||
|
* console.log('an event occurred!');
|
||||||
|
* });
|
||||||
|
* myEmitter.emit('event');
|
||||||
|
* ```
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/events.js)
|
||||||
|
*/
|
||||||
|
declare module "events" {
|
||||||
|
import { AsyncResource, AsyncResourceOptions } from "node:async_hooks";
|
||||||
|
interface EventEmitterOptions {
|
||||||
|
/**
|
||||||
|
* Enables automatic capturing of promise rejection.
|
||||||
|
*/
|
||||||
|
captureRejections?: boolean | undefined;
|
||||||
|
}
|
||||||
|
interface StaticEventEmitterOptions {
|
||||||
|
/**
|
||||||
|
* Can be used to cancel awaiting events.
|
||||||
|
*/
|
||||||
|
signal?: AbortSignal | undefined;
|
||||||
|
}
|
||||||
|
interface StaticEventEmitterIteratorOptions extends StaticEventEmitterOptions {
|
||||||
|
/**
|
||||||
|
* Names of events that will end the iteration.
|
||||||
|
*/
|
||||||
|
close?: string[] | undefined;
|
||||||
|
/**
|
||||||
|
* The high watermark. The emitter is paused every time the size of events being buffered is higher than it.
|
||||||
|
* Supported only on emitters implementing `pause()` and `resume()` methods.
|
||||||
|
* @default Number.MAX_SAFE_INTEGER
|
||||||
|
*/
|
||||||
|
highWaterMark?: number | undefined;
|
||||||
|
/**
|
||||||
|
* The low watermark. The emitter is resumed every time the size of events being buffered is lower than it.
|
||||||
|
* Supported only on emitters implementing `pause()` and `resume()` methods.
|
||||||
|
* @default 1
|
||||||
|
*/
|
||||||
|
lowWaterMark?: number | undefined;
|
||||||
|
}
|
||||||
|
interface EventEmitter<T extends EventMap<T> = DefaultEventMap> extends NodeJS.EventEmitter<T> {}
|
||||||
|
type EventMap<T> = Record<keyof T, any[]> | DefaultEventMap;
|
||||||
|
type DefaultEventMap = [never];
|
||||||
|
type AnyRest = [...args: any[]];
|
||||||
|
type Args<K, T> = T extends DefaultEventMap ? AnyRest : (
|
||||||
|
K extends keyof T ? T[K] : never
|
||||||
|
);
|
||||||
|
type Key<K, T> = T extends DefaultEventMap ? string | symbol : K | keyof T;
|
||||||
|
type Key2<K, T> = T extends DefaultEventMap ? string | symbol : K & keyof T;
|
||||||
|
type Listener<K, T, F> = T extends DefaultEventMap ? F : (
|
||||||
|
K extends keyof T ? (
|
||||||
|
T[K] extends unknown[] ? (...args: T[K]) => void : never
|
||||||
|
)
|
||||||
|
: never
|
||||||
|
);
|
||||||
|
type Listener1<K, T> = Listener<K, T, (...args: any[]) => void>;
|
||||||
|
type Listener2<K, T> = Listener<K, T, Function>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The `EventEmitter` class is defined and exposed by the `node:events` module:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* All `EventEmitter`s emit the event `'newListener'` when new listeners are
|
||||||
|
* added and `'removeListener'` when existing listeners are removed.
|
||||||
|
*
|
||||||
|
* It supports the following option:
|
||||||
|
* @since v0.1.26
|
||||||
|
*/
|
||||||
|
class EventEmitter<T extends EventMap<T> = DefaultEventMap> {
|
||||||
|
constructor(options?: EventEmitterOptions);
|
||||||
|
|
||||||
|
[EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: Key<K, T>, ...args: Args<K, T>): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
|
||||||
|
* event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
|
||||||
|
* The `Promise` will resolve with an array of all the arguments emitted to the
|
||||||
|
* given event.
|
||||||
|
*
|
||||||
|
* This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event
|
||||||
|
* semantics and does not listen to the `'error'` event.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { once, EventEmitter } from 'node:events';
|
||||||
|
* import process from 'node:process';
|
||||||
|
*
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
*
|
||||||
|
* process.nextTick(() => {
|
||||||
|
* ee.emit('myevent', 42);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* const [value] = await once(ee, 'myevent');
|
||||||
|
* console.log(value);
|
||||||
|
*
|
||||||
|
* const err = new Error('kaboom');
|
||||||
|
* process.nextTick(() => {
|
||||||
|
* ee.emit('error', err);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* try {
|
||||||
|
* await once(ee, 'myevent');
|
||||||
|
* } catch (err) {
|
||||||
|
* console.error('error happened', err);
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The special handling of the `'error'` event is only used when `events.once()` is used to wait for another event. If `events.once()` is used to wait for the
|
||||||
|
* '`error'` event itself, then it is treated as any other kind of event without
|
||||||
|
* special handling:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter, once } from 'node:events';
|
||||||
|
*
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
*
|
||||||
|
* once(ee, 'error')
|
||||||
|
* .then(([err]) => console.log('ok', err.message))
|
||||||
|
* .catch((err) => console.error('error', err.message));
|
||||||
|
*
|
||||||
|
* ee.emit('error', new Error('boom'));
|
||||||
|
*
|
||||||
|
* // Prints: ok boom
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* An `AbortSignal` can be used to cancel waiting for the event:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter, once } from 'node:events';
|
||||||
|
*
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
* const ac = new AbortController();
|
||||||
|
*
|
||||||
|
* async function foo(emitter, event, signal) {
|
||||||
|
* try {
|
||||||
|
* await once(emitter, event, { signal });
|
||||||
|
* console.log('event emitted!');
|
||||||
|
* } catch (error) {
|
||||||
|
* if (error.name === 'AbortError') {
|
||||||
|
* console.error('Waiting for the event was canceled!');
|
||||||
|
* } else {
|
||||||
|
* console.error('There was an error', error.message);
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* foo(ee, 'foo', ac.signal);
|
||||||
|
* ac.abort(); // Abort waiting for the event
|
||||||
|
* ee.emit('foo'); // Prints: Waiting for the event was canceled!
|
||||||
|
* ```
|
||||||
|
* @since v11.13.0, v10.16.0
|
||||||
|
*/
|
||||||
|
static once(
|
||||||
|
emitter: NodeJS.EventEmitter,
|
||||||
|
eventName: string | symbol,
|
||||||
|
options?: StaticEventEmitterOptions,
|
||||||
|
): Promise<any[]>;
|
||||||
|
static once(emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>;
|
||||||
|
/**
|
||||||
|
* ```js
|
||||||
|
* import { on, EventEmitter } from 'node:events';
|
||||||
|
* import process from 'node:process';
|
||||||
|
*
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
*
|
||||||
|
* // Emit later on
|
||||||
|
* process.nextTick(() => {
|
||||||
|
* ee.emit('foo', 'bar');
|
||||||
|
* ee.emit('foo', 42);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* for await (const event of on(ee, 'foo')) {
|
||||||
|
* // The execution of this inner block is synchronous and it
|
||||||
|
* // processes one event at a time (even with await). Do not use
|
||||||
|
* // if concurrent execution is required.
|
||||||
|
* console.log(event); // prints ['bar'] [42]
|
||||||
|
* }
|
||||||
|
* // Unreachable here
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Returns an `AsyncIterator` that iterates `eventName` events. It will throw
|
||||||
|
* if the `EventEmitter` emits `'error'`. It removes all listeners when
|
||||||
|
* exiting the loop. The `value` returned by each iteration is an array
|
||||||
|
* composed of the emitted event arguments.
|
||||||
|
*
|
||||||
|
* An `AbortSignal` can be used to cancel waiting on events:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { on, EventEmitter } from 'node:events';
|
||||||
|
* import process from 'node:process';
|
||||||
|
*
|
||||||
|
* const ac = new AbortController();
|
||||||
|
*
|
||||||
|
* (async () => {
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
*
|
||||||
|
* // Emit later on
|
||||||
|
* process.nextTick(() => {
|
||||||
|
* ee.emit('foo', 'bar');
|
||||||
|
* ee.emit('foo', 42);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* for await (const event of on(ee, 'foo', { signal: ac.signal })) {
|
||||||
|
* // The execution of this inner block is synchronous and it
|
||||||
|
* // processes one event at a time (even with await). Do not use
|
||||||
|
* // if concurrent execution is required.
|
||||||
|
* console.log(event); // prints ['bar'] [42]
|
||||||
|
* }
|
||||||
|
* // Unreachable here
|
||||||
|
* })();
|
||||||
|
*
|
||||||
|
* process.nextTick(() => ac.abort());
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Use the `close` option to specify an array of event names that will end the iteration:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { on, EventEmitter } from 'node:events';
|
||||||
|
* import process from 'node:process';
|
||||||
|
*
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
*
|
||||||
|
* // Emit later on
|
||||||
|
* process.nextTick(() => {
|
||||||
|
* ee.emit('foo', 'bar');
|
||||||
|
* ee.emit('foo', 42);
|
||||||
|
* ee.emit('close');
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* for await (const event of on(ee, 'foo', { close: ['close'] })) {
|
||||||
|
* console.log(event); // prints ['bar'] [42]
|
||||||
|
* }
|
||||||
|
* // the loop will exit after 'close' is emitted
|
||||||
|
* console.log('done'); // prints 'done'
|
||||||
|
* ```
|
||||||
|
* @since v13.6.0, v12.16.0
|
||||||
|
* @return An `AsyncIterator` that iterates `eventName` events emitted by the `emitter`
|
||||||
|
*/
|
||||||
|
static on(
|
||||||
|
emitter: NodeJS.EventEmitter,
|
||||||
|
eventName: string | symbol,
|
||||||
|
options?: StaticEventEmitterIteratorOptions,
|
||||||
|
): NodeJS.AsyncIterator<any[]>;
|
||||||
|
static on(
|
||||||
|
emitter: EventTarget,
|
||||||
|
eventName: string,
|
||||||
|
options?: StaticEventEmitterIteratorOptions,
|
||||||
|
): NodeJS.AsyncIterator<any[]>;
|
||||||
|
/**
|
||||||
|
* A class method that returns the number of listeners for the given `eventName` registered on the given `emitter`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter, listenerCount } from 'node:events';
|
||||||
|
*
|
||||||
|
* const myEmitter = new EventEmitter();
|
||||||
|
* myEmitter.on('event', () => {});
|
||||||
|
* myEmitter.on('event', () => {});
|
||||||
|
* console.log(listenerCount(myEmitter, 'event'));
|
||||||
|
* // Prints: 2
|
||||||
|
* ```
|
||||||
|
* @since v0.9.12
|
||||||
|
* @deprecated Since v3.2.0 - Use `listenerCount` instead.
|
||||||
|
* @param emitter The emitter to query
|
||||||
|
* @param eventName The event name
|
||||||
|
*/
|
||||||
|
static listenerCount(emitter: NodeJS.EventEmitter, eventName: string | symbol): number;
|
||||||
|
/**
|
||||||
|
* Returns a copy of the array of listeners for the event named `eventName`.
|
||||||
|
*
|
||||||
|
* For `EventEmitter`s this behaves exactly the same as calling `.listeners` on
|
||||||
|
* the emitter.
|
||||||
|
*
|
||||||
|
* For `EventTarget`s this is the only way to get the event listeners for the
|
||||||
|
* event target. This is useful for debugging and diagnostic purposes.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { getEventListeners, EventEmitter } from 'node:events';
|
||||||
|
*
|
||||||
|
* {
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
* const listener = () => console.log('Events are fun');
|
||||||
|
* ee.on('foo', listener);
|
||||||
|
* console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
|
||||||
|
* }
|
||||||
|
* {
|
||||||
|
* const et = new EventTarget();
|
||||||
|
* const listener = () => console.log('Events are fun');
|
||||||
|
* et.addEventListener('foo', listener);
|
||||||
|
* console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v15.2.0, v14.17.0
|
||||||
|
*/
|
||||||
|
static getEventListeners(emitter: EventTarget | NodeJS.EventEmitter, name: string | symbol): Function[];
|
||||||
|
/**
|
||||||
|
* Returns the currently set max amount of listeners.
|
||||||
|
*
|
||||||
|
* For `EventEmitter`s this behaves exactly the same as calling `.getMaxListeners` on
|
||||||
|
* the emitter.
|
||||||
|
*
|
||||||
|
* For `EventTarget`s this is the only way to get the max event listeners for the
|
||||||
|
* event target. If the number of event handlers on a single EventTarget exceeds
|
||||||
|
* the max set, the EventTarget will print a warning.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
|
||||||
|
*
|
||||||
|
* {
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
* console.log(getMaxListeners(ee)); // 10
|
||||||
|
* setMaxListeners(11, ee);
|
||||||
|
* console.log(getMaxListeners(ee)); // 11
|
||||||
|
* }
|
||||||
|
* {
|
||||||
|
* const et = new EventTarget();
|
||||||
|
* console.log(getMaxListeners(et)); // 10
|
||||||
|
* setMaxListeners(11, et);
|
||||||
|
* console.log(getMaxListeners(et)); // 11
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v19.9.0
|
||||||
|
*/
|
||||||
|
static getMaxListeners(emitter: EventTarget | NodeJS.EventEmitter): number;
|
||||||
|
/**
|
||||||
|
* ```js
|
||||||
|
* import { setMaxListeners, EventEmitter } from 'node:events';
|
||||||
|
*
|
||||||
|
* const target = new EventTarget();
|
||||||
|
* const emitter = new EventEmitter();
|
||||||
|
*
|
||||||
|
* setMaxListeners(5, target, emitter);
|
||||||
|
* ```
|
||||||
|
* @since v15.4.0
|
||||||
|
* @param n A non-negative number. The maximum number of listeners per `EventTarget` event.
|
||||||
|
* @param eventTargets Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, `n` is set as the default max for all newly created {EventTarget} and {EventEmitter}
|
||||||
|
* objects.
|
||||||
|
*/
|
||||||
|
static setMaxListeners(n?: number, ...eventTargets: Array<EventTarget | NodeJS.EventEmitter>): void;
|
||||||
|
/**
|
||||||
|
* Listens once to the `abort` event on the provided `signal`.
|
||||||
|
*
|
||||||
|
* Listening to the `abort` event on abort signals is unsafe and may
|
||||||
|
* lead to resource leaks since another third party with the signal can
|
||||||
|
* call `e.stopImmediatePropagation()`. Unfortunately Node.js cannot change
|
||||||
|
* this since it would violate the web standard. Additionally, the original
|
||||||
|
* API makes it easy to forget to remove listeners.
|
||||||
|
*
|
||||||
|
* This API allows safely using `AbortSignal`s in Node.js APIs by solving these
|
||||||
|
* two issues by listening to the event such that `stopImmediatePropagation` does
|
||||||
|
* not prevent the listener from running.
|
||||||
|
*
|
||||||
|
* Returns a disposable so that it may be unsubscribed from more easily.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { addAbortListener } from 'node:events';
|
||||||
|
*
|
||||||
|
* function example(signal) {
|
||||||
|
* let disposable;
|
||||||
|
* try {
|
||||||
|
* signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
|
||||||
|
* disposable = addAbortListener(signal, (e) => {
|
||||||
|
* // Do something when signal is aborted.
|
||||||
|
* });
|
||||||
|
* } finally {
|
||||||
|
* disposable?.[Symbol.dispose]();
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v20.5.0
|
||||||
|
* @experimental
|
||||||
|
* @return Disposable that removes the `abort` listener.
|
||||||
|
*/
|
||||||
|
static addAbortListener(signal: AbortSignal, resource: (event: Event) => void): Disposable;
|
||||||
|
/**
|
||||||
|
* This symbol shall be used to install a listener for only monitoring `'error'` events. Listeners installed using this symbol are called before the regular `'error'` listeners are called.
|
||||||
|
*
|
||||||
|
* Installing a listener using this symbol does not change the behavior once an `'error'` event is emitted. Therefore, the process will still crash if no
|
||||||
|
* regular `'error'` listener is installed.
|
||||||
|
* @since v13.6.0, v12.17.0
|
||||||
|
*/
|
||||||
|
static readonly errorMonitor: unique symbol;
|
||||||
|
/**
|
||||||
|
* Value: `Symbol.for('nodejs.rejection')`
|
||||||
|
*
|
||||||
|
* See how to write a custom `rejection handler`.
|
||||||
|
* @since v13.4.0, v12.16.0
|
||||||
|
*/
|
||||||
|
static readonly captureRejectionSymbol: unique symbol;
|
||||||
|
/**
|
||||||
|
* Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
|
||||||
|
*
|
||||||
|
* Change the default `captureRejections` option on all new `EventEmitter` objects.
|
||||||
|
* @since v13.4.0, v12.16.0
|
||||||
|
*/
|
||||||
|
static captureRejections: boolean;
|
||||||
|
/**
|
||||||
|
* By default, a maximum of `10` listeners can be registered for any single
|
||||||
|
* event. This limit can be changed for individual `EventEmitter` instances
|
||||||
|
* using the `emitter.setMaxListeners(n)` method. To change the default
|
||||||
|
* for _all_`EventEmitter` instances, the `events.defaultMaxListeners` property
|
||||||
|
* can be used. If this value is not a positive number, a `RangeError` is thrown.
|
||||||
|
*
|
||||||
|
* Take caution when setting the `events.defaultMaxListeners` because the
|
||||||
|
* change affects _all_ `EventEmitter` instances, including those created before
|
||||||
|
* the change is made. However, calling `emitter.setMaxListeners(n)` still has
|
||||||
|
* precedence over `events.defaultMaxListeners`.
|
||||||
|
*
|
||||||
|
* This is not a hard limit. The `EventEmitter` instance will allow
|
||||||
|
* more listeners to be added but will output a trace warning to stderr indicating
|
||||||
|
* that a "possible EventEmitter memory leak" has been detected. For any single
|
||||||
|
* `EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()` methods can be used to
|
||||||
|
* temporarily avoid this warning:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
* const emitter = new EventEmitter();
|
||||||
|
* emitter.setMaxListeners(emitter.getMaxListeners() + 1);
|
||||||
|
* emitter.once('event', () => {
|
||||||
|
* // do stuff
|
||||||
|
* emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The `--trace-warnings` command-line flag can be used to display the
|
||||||
|
* stack trace for such warnings.
|
||||||
|
*
|
||||||
|
* The emitted warning can be inspected with `process.on('warning')` and will
|
||||||
|
* have the additional `emitter`, `type`, and `count` properties, referring to
|
||||||
|
* the event emitter instance, the event's name and the number of attached
|
||||||
|
* listeners, respectively.
|
||||||
|
* Its `name` property is set to `'MaxListenersExceededWarning'`.
|
||||||
|
* @since v0.11.2
|
||||||
|
*/
|
||||||
|
static defaultMaxListeners: number;
|
||||||
|
}
|
||||||
|
import internal = require("node:events");
|
||||||
|
namespace EventEmitter {
|
||||||
|
// Should just be `export { EventEmitter }`, but that doesn't work in TypeScript 3.4
|
||||||
|
export { internal as EventEmitter };
|
||||||
|
export interface Abortable {
|
||||||
|
/**
|
||||||
|
* When provided the corresponding `AbortController` can be used to cancel an asynchronous action.
|
||||||
|
*/
|
||||||
|
signal?: AbortSignal | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface EventEmitterReferencingAsyncResource extends AsyncResource {
|
||||||
|
readonly eventEmitter: EventEmitterAsyncResource;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface EventEmitterAsyncResourceOptions extends AsyncResourceOptions, EventEmitterOptions {
|
||||||
|
/**
|
||||||
|
* The type of async event, this is required when instantiating `EventEmitterAsyncResource`
|
||||||
|
* directly rather than as a child class.
|
||||||
|
* @default new.target.name if instantiated as a child class.
|
||||||
|
*/
|
||||||
|
name?: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Integrates `EventEmitter` with `AsyncResource` for `EventEmitter`s that
|
||||||
|
* require manual async tracking. Specifically, all events emitted by instances
|
||||||
|
* of `events.EventEmitterAsyncResource` will run within its `async context`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitterAsyncResource, EventEmitter } from 'node:events';
|
||||||
|
* import { notStrictEqual, strictEqual } from 'node:assert';
|
||||||
|
* import { executionAsyncId, triggerAsyncId } from 'node:async_hooks';
|
||||||
|
*
|
||||||
|
* // Async tracking tooling will identify this as 'Q'.
|
||||||
|
* const ee1 = new EventEmitterAsyncResource({ name: 'Q' });
|
||||||
|
*
|
||||||
|
* // 'foo' listeners will run in the EventEmitters async context.
|
||||||
|
* ee1.on('foo', () => {
|
||||||
|
* strictEqual(executionAsyncId(), ee1.asyncId);
|
||||||
|
* strictEqual(triggerAsyncId(), ee1.triggerAsyncId);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* const ee2 = new EventEmitter();
|
||||||
|
*
|
||||||
|
* // 'foo' listeners on ordinary EventEmitters that do not track async
|
||||||
|
* // context, however, run in the same async context as the emit().
|
||||||
|
* ee2.on('foo', () => {
|
||||||
|
* notStrictEqual(executionAsyncId(), ee2.asyncId);
|
||||||
|
* notStrictEqual(triggerAsyncId(), ee2.triggerAsyncId);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* Promise.resolve().then(() => {
|
||||||
|
* ee1.emit('foo');
|
||||||
|
* ee2.emit('foo');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The `EventEmitterAsyncResource` class has the same methods and takes the
|
||||||
|
* same options as `EventEmitter` and `AsyncResource` themselves.
|
||||||
|
* @since v17.4.0, v16.14.0
|
||||||
|
*/
|
||||||
|
export class EventEmitterAsyncResource extends EventEmitter {
|
||||||
|
/**
|
||||||
|
* @param options Only optional in child class.
|
||||||
|
*/
|
||||||
|
constructor(options?: EventEmitterAsyncResourceOptions);
|
||||||
|
/**
|
||||||
|
* Call all `destroy` hooks. This should only ever be called once. An error will
|
||||||
|
* be thrown if it is called more than once. This **must** be manually called. If
|
||||||
|
* the resource is left to be collected by the GC then the `destroy` hooks will
|
||||||
|
* never be called.
|
||||||
|
*/
|
||||||
|
emitDestroy(): void;
|
||||||
|
/**
|
||||||
|
* The unique `asyncId` assigned to the resource.
|
||||||
|
*/
|
||||||
|
readonly asyncId: number;
|
||||||
|
/**
|
||||||
|
* The same triggerAsyncId that is passed to the AsyncResource constructor.
|
||||||
|
*/
|
||||||
|
readonly triggerAsyncId: number;
|
||||||
|
/**
|
||||||
|
* The returned `AsyncResource` object has an additional `eventEmitter` property
|
||||||
|
* that provides a reference to this `EventEmitterAsyncResource`.
|
||||||
|
*/
|
||||||
|
readonly asyncResource: EventEmitterReferencingAsyncResource;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The `NodeEventTarget` is a Node.js-specific extension to `EventTarget`
|
||||||
|
* that emulates a subset of the `EventEmitter` API.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
export interface NodeEventTarget extends EventTarget {
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class that emulates the
|
||||||
|
* equivalent `EventEmitter` API. The only difference between `addListener()` and
|
||||||
|
* `addEventListener()` is that `addListener()` will return a reference to the
|
||||||
|
* `EventTarget`.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
addListener(type: string, listener: (arg: any) => void): this;
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class that dispatches the
|
||||||
|
* `arg` to the list of handlers for `type`.
|
||||||
|
* @since v15.2.0
|
||||||
|
* @returns `true` if event listeners registered for the `type` exist,
|
||||||
|
* otherwise `false`.
|
||||||
|
*/
|
||||||
|
emit(type: string, arg: any): boolean;
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class that returns an array
|
||||||
|
* of event `type` names for which event listeners are registered.
|
||||||
|
* @since 14.5.0
|
||||||
|
*/
|
||||||
|
eventNames(): string[];
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class that returns the number
|
||||||
|
* of event listeners registered for the `type`.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
listenerCount(type: string): number;
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class that sets the number
|
||||||
|
* of max event listeners as `n`.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
setMaxListeners(n: number): void;
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class that returns the number
|
||||||
|
* of max event listeners.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
getMaxListeners(): number;
|
||||||
|
/**
|
||||||
|
* Node.js-specific alias for `eventTarget.removeEventListener()`.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
off(type: string, listener: (arg: any) => void, options?: EventListenerOptions): this;
|
||||||
|
/**
|
||||||
|
* Node.js-specific alias for `eventTarget.addEventListener()`.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
on(type: string, listener: (arg: any) => void): this;
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class that adds a `once`
|
||||||
|
* listener for the given event `type`. This is equivalent to calling `on`
|
||||||
|
* with the `once` option set to `true`.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
once(type: string, listener: (arg: any) => void): this;
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class. If `type` is specified,
|
||||||
|
* removes all registered listeners for `type`, otherwise removes all registered
|
||||||
|
* listeners.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
removeAllListeners(type?: string): this;
|
||||||
|
/**
|
||||||
|
* Node.js-specific extension to the `EventTarget` class that removes the
|
||||||
|
* `listener` for the given `type`. The only difference between `removeListener()`
|
||||||
|
* and `removeEventListener()` is that `removeListener()` will return a reference
|
||||||
|
* to the `EventTarget`.
|
||||||
|
* @since v14.5.0
|
||||||
|
*/
|
||||||
|
removeListener(type: string, listener: (arg: any) => void, options?: EventListenerOptions): this;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
global {
|
||||||
|
namespace NodeJS {
|
||||||
|
interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
|
||||||
|
[EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: Key<K, T>, ...args: Args<K, T>): void;
|
||||||
|
/**
|
||||||
|
* Alias for `emitter.on(eventName, listener)`.
|
||||||
|
* @since v0.1.26
|
||||||
|
*/
|
||||||
|
addListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
||||||
|
/**
|
||||||
|
* Adds the `listener` function to the end of the listeners array for the event
|
||||||
|
* named `eventName`. No checks are made to see if the `listener` has already
|
||||||
|
* been added. Multiple calls passing the same combination of `eventName` and
|
||||||
|
* `listener` will result in the `listener` being added, and called, multiple times.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* server.on('connection', (stream) => {
|
||||||
|
* console.log('someone connected!');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
*
|
||||||
|
* By default, event listeners are invoked in the order they are added. The `emitter.prependListener()` method can be used as an alternative to add the
|
||||||
|
* event listener to the beginning of the listeners array.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
* const myEE = new EventEmitter();
|
||||||
|
* myEE.on('foo', () => console.log('a'));
|
||||||
|
* myEE.prependListener('foo', () => console.log('b'));
|
||||||
|
* myEE.emit('foo');
|
||||||
|
* // Prints:
|
||||||
|
* // b
|
||||||
|
* // a
|
||||||
|
* ```
|
||||||
|
* @since v0.1.101
|
||||||
|
* @param eventName The name of the event.
|
||||||
|
* @param listener The callback function
|
||||||
|
*/
|
||||||
|
on<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
||||||
|
/**
|
||||||
|
* Adds a **one-time** `listener` function for the event named `eventName`. The
|
||||||
|
* next time `eventName` is triggered, this listener is removed and then invoked.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* server.once('connection', (stream) => {
|
||||||
|
* console.log('Ah, we have our first user!');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
*
|
||||||
|
* By default, event listeners are invoked in the order they are added. The `emitter.prependOnceListener()` method can be used as an alternative to add the
|
||||||
|
* event listener to the beginning of the listeners array.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
* const myEE = new EventEmitter();
|
||||||
|
* myEE.once('foo', () => console.log('a'));
|
||||||
|
* myEE.prependOnceListener('foo', () => console.log('b'));
|
||||||
|
* myEE.emit('foo');
|
||||||
|
* // Prints:
|
||||||
|
* // b
|
||||||
|
* // a
|
||||||
|
* ```
|
||||||
|
* @since v0.3.0
|
||||||
|
* @param eventName The name of the event.
|
||||||
|
* @param listener The callback function
|
||||||
|
*/
|
||||||
|
once<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
||||||
|
/**
|
||||||
|
* Removes the specified `listener` from the listener array for the event named `eventName`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const callback = (stream) => {
|
||||||
|
* console.log('someone connected!');
|
||||||
|
* };
|
||||||
|
* server.on('connection', callback);
|
||||||
|
* // ...
|
||||||
|
* server.removeListener('connection', callback);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* `removeListener()` will remove, at most, one instance of a listener from the
|
||||||
|
* listener array. If any single listener has been added multiple times to the
|
||||||
|
* listener array for the specified `eventName`, then `removeListener()` must be
|
||||||
|
* called multiple times to remove each instance.
|
||||||
|
*
|
||||||
|
* Once an event is emitted, all listeners attached to it at the
|
||||||
|
* time of emitting are called in order. This implies that any `removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution
|
||||||
|
* will not remove them from`emit()` in progress. Subsequent events behave as expected.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
* class MyEmitter extends EventEmitter {}
|
||||||
|
* const myEmitter = new MyEmitter();
|
||||||
|
*
|
||||||
|
* const callbackA = () => {
|
||||||
|
* console.log('A');
|
||||||
|
* myEmitter.removeListener('event', callbackB);
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* const callbackB = () => {
|
||||||
|
* console.log('B');
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* myEmitter.on('event', callbackA);
|
||||||
|
*
|
||||||
|
* myEmitter.on('event', callbackB);
|
||||||
|
*
|
||||||
|
* // callbackA removes listener callbackB but it will still be called.
|
||||||
|
* // Internal listener array at time of emit [callbackA, callbackB]
|
||||||
|
* myEmitter.emit('event');
|
||||||
|
* // Prints:
|
||||||
|
* // A
|
||||||
|
* // B
|
||||||
|
*
|
||||||
|
* // callbackB is now removed.
|
||||||
|
* // Internal listener array [callbackA]
|
||||||
|
* myEmitter.emit('event');
|
||||||
|
* // Prints:
|
||||||
|
* // A
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Because listeners are managed using an internal array, calling this will
|
||||||
|
* change the position indices of any listener registered _after_ the listener
|
||||||
|
* being removed. This will not impact the order in which listeners are called,
|
||||||
|
* but it means that any copies of the listener array as returned by
|
||||||
|
* the `emitter.listeners()` method will need to be recreated.
|
||||||
|
*
|
||||||
|
* When a single function has been added as a handler multiple times for a single
|
||||||
|
* event (as in the example below), `removeListener()` will remove the most
|
||||||
|
* recently added instance. In the example the `once('ping')` listener is removed:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
* const ee = new EventEmitter();
|
||||||
|
*
|
||||||
|
* function pong() {
|
||||||
|
* console.log('pong');
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* ee.on('ping', pong);
|
||||||
|
* ee.once('ping', pong);
|
||||||
|
* ee.removeListener('ping', pong);
|
||||||
|
*
|
||||||
|
* ee.emit('ping');
|
||||||
|
* ee.emit('ping');
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
* @since v0.1.26
|
||||||
|
*/
|
||||||
|
removeListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
||||||
|
/**
|
||||||
|
* Alias for `emitter.removeListener()`.
|
||||||
|
* @since v10.0.0
|
||||||
|
*/
|
||||||
|
off<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
||||||
|
/**
|
||||||
|
* Removes all listeners, or those of the specified `eventName`.
|
||||||
|
*
|
||||||
|
* It is bad practice to remove listeners added elsewhere in the code,
|
||||||
|
* particularly when the `EventEmitter` instance was created by some other
|
||||||
|
* component or module (e.g. sockets or file streams).
|
||||||
|
*
|
||||||
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
* @since v0.1.26
|
||||||
|
*/
|
||||||
|
removeAllListeners(eventName?: Key<unknown, T>): this;
|
||||||
|
/**
|
||||||
|
* By default `EventEmitter`s will print a warning if more than `10` listeners are
|
||||||
|
* added for a particular event. This is a useful default that helps finding
|
||||||
|
* memory leaks. The `emitter.setMaxListeners()` method allows the limit to be
|
||||||
|
* modified for this specific `EventEmitter` instance. The value can be set to `Infinity` (or `0`) to indicate an unlimited number of listeners.
|
||||||
|
*
|
||||||
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
* @since v0.3.5
|
||||||
|
*/
|
||||||
|
setMaxListeners(n: number): this;
|
||||||
|
/**
|
||||||
|
* Returns the current max listener value for the `EventEmitter` which is either
|
||||||
|
* set by `emitter.setMaxListeners(n)` or defaults to {@link EventEmitter.defaultMaxListeners}.
|
||||||
|
* @since v1.0.0
|
||||||
|
*/
|
||||||
|
getMaxListeners(): number;
|
||||||
|
/**
|
||||||
|
* Returns a copy of the array of listeners for the event named `eventName`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* server.on('connection', (stream) => {
|
||||||
|
* console.log('someone connected!');
|
||||||
|
* });
|
||||||
|
* console.log(util.inspect(server.listeners('connection')));
|
||||||
|
* // Prints: [ [Function] ]
|
||||||
|
* ```
|
||||||
|
* @since v0.1.26
|
||||||
|
*/
|
||||||
|
listeners<K>(eventName: Key<K, T>): Array<Listener2<K, T>>;
|
||||||
|
/**
|
||||||
|
* Returns a copy of the array of listeners for the event named `eventName`,
|
||||||
|
* including any wrappers (such as those created by `.once()`).
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
* const emitter = new EventEmitter();
|
||||||
|
* emitter.once('log', () => console.log('log once'));
|
||||||
|
*
|
||||||
|
* // Returns a new Array with a function `onceWrapper` which has a property
|
||||||
|
* // `listener` which contains the original listener bound above
|
||||||
|
* const listeners = emitter.rawListeners('log');
|
||||||
|
* const logFnWrapper = listeners[0];
|
||||||
|
*
|
||||||
|
* // Logs "log once" to the console and does not unbind the `once` event
|
||||||
|
* logFnWrapper.listener();
|
||||||
|
*
|
||||||
|
* // Logs "log once" to the console and removes the listener
|
||||||
|
* logFnWrapper();
|
||||||
|
*
|
||||||
|
* emitter.on('log', () => console.log('log persistently'));
|
||||||
|
* // Will return a new Array with a single function bound by `.on()` above
|
||||||
|
* const newListeners = emitter.rawListeners('log');
|
||||||
|
*
|
||||||
|
* // Logs "log persistently" twice
|
||||||
|
* newListeners[0]();
|
||||||
|
* emitter.emit('log');
|
||||||
|
* ```
|
||||||
|
* @since v9.4.0
|
||||||
|
*/
|
||||||
|
rawListeners<K>(eventName: Key<K, T>): Array<Listener2<K, T>>;
|
||||||
|
/**
|
||||||
|
* Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments
|
||||||
|
* to each.
|
||||||
|
*
|
||||||
|
* Returns `true` if the event had listeners, `false` otherwise.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
* const myEmitter = new EventEmitter();
|
||||||
|
*
|
||||||
|
* // First listener
|
||||||
|
* myEmitter.on('event', function firstListener() {
|
||||||
|
* console.log('Helloooo! first listener');
|
||||||
|
* });
|
||||||
|
* // Second listener
|
||||||
|
* myEmitter.on('event', function secondListener(arg1, arg2) {
|
||||||
|
* console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
|
||||||
|
* });
|
||||||
|
* // Third listener
|
||||||
|
* myEmitter.on('event', function thirdListener(...args) {
|
||||||
|
* const parameters = args.join(', ');
|
||||||
|
* console.log(`event with parameters ${parameters} in third listener`);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* console.log(myEmitter.listeners('event'));
|
||||||
|
*
|
||||||
|
* myEmitter.emit('event', 1, 2, 3, 4, 5);
|
||||||
|
*
|
||||||
|
* // Prints:
|
||||||
|
* // [
|
||||||
|
* // [Function: firstListener],
|
||||||
|
* // [Function: secondListener],
|
||||||
|
* // [Function: thirdListener]
|
||||||
|
* // ]
|
||||||
|
* // Helloooo! first listener
|
||||||
|
* // event with parameters 1, 2 in second listener
|
||||||
|
* // event with parameters 1, 2, 3, 4, 5 in third listener
|
||||||
|
* ```
|
||||||
|
* @since v0.1.26
|
||||||
|
*/
|
||||||
|
emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
|
||||||
|
/**
|
||||||
|
* Returns the number of listeners listening for the event named `eventName`.
|
||||||
|
* If `listener` is provided, it will return how many times the listener is found
|
||||||
|
* in the list of the listeners of the event.
|
||||||
|
* @since v3.2.0
|
||||||
|
* @param eventName The name of the event being listened for
|
||||||
|
* @param listener The event handler function
|
||||||
|
*/
|
||||||
|
listenerCount<K>(eventName: Key<K, T>, listener?: Listener2<K, T>): number;
|
||||||
|
/**
|
||||||
|
* Adds the `listener` function to the _beginning_ of the listeners array for the
|
||||||
|
* event named `eventName`. No checks are made to see if the `listener` has
|
||||||
|
* already been added. Multiple calls passing the same combination of `eventName`
|
||||||
|
* and `listener` will result in the `listener` being added, and called, multiple times.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* server.prependListener('connection', (stream) => {
|
||||||
|
* console.log('someone connected!');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
* @since v6.0.0
|
||||||
|
* @param eventName The name of the event.
|
||||||
|
* @param listener The callback function
|
||||||
|
*/
|
||||||
|
prependListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
||||||
|
/**
|
||||||
|
* Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
|
||||||
|
* listener is removed, and then invoked.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* server.prependOnceListener('connection', (stream) => {
|
||||||
|
* console.log('Ah, we have our first user!');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Returns a reference to the `EventEmitter`, so that calls can be chained.
|
||||||
|
* @since v6.0.0
|
||||||
|
* @param eventName The name of the event.
|
||||||
|
* @param listener The callback function
|
||||||
|
*/
|
||||||
|
prependOnceListener<K>(eventName: Key<K, T>, listener: Listener1<K, T>): this;
|
||||||
|
/**
|
||||||
|
* Returns an array listing the events for which the emitter has registered
|
||||||
|
* listeners. The values in the array are strings or `Symbol`s.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { EventEmitter } from 'node:events';
|
||||||
|
*
|
||||||
|
* const myEE = new EventEmitter();
|
||||||
|
* myEE.on('foo', () => {});
|
||||||
|
* myEE.on('bar', () => {});
|
||||||
|
*
|
||||||
|
* const sym = Symbol('symbol');
|
||||||
|
* myEE.on(sym, () => {});
|
||||||
|
*
|
||||||
|
* console.log(myEE.eventNames());
|
||||||
|
* // Prints: [ 'foo', 'bar', Symbol(symbol) ]
|
||||||
|
* ```
|
||||||
|
* @since v6.0.0
|
||||||
|
*/
|
||||||
|
eventNames(): Array<(string | symbol) & Key2<unknown, T>>;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
export = EventEmitter;
|
||||||
|
}
|
||||||
|
declare module "node:events" {
|
||||||
|
import events = require("events");
|
||||||
|
export = events;
|
||||||
|
}
|
||||||
+4375
File diff suppressed because it is too large
Load Diff
+1270
File diff suppressed because it is too large
Load Diff
+172
@@ -0,0 +1,172 @@
|
|||||||
|
declare var global: typeof globalThis;
|
||||||
|
|
||||||
|
declare var process: NodeJS.Process;
|
||||||
|
declare var console: Console;
|
||||||
|
|
||||||
|
interface ErrorConstructor {
|
||||||
|
/**
|
||||||
|
* Creates a `.stack` property on `targetObject`, which when accessed returns
|
||||||
|
* a string representing the location in the code at which
|
||||||
|
* `Error.captureStackTrace()` was called.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const myObject = {};
|
||||||
|
* Error.captureStackTrace(myObject);
|
||||||
|
* myObject.stack; // Similar to `new Error().stack`
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* The first line of the trace will be prefixed with
|
||||||
|
* `${myObject.name}: ${myObject.message}`.
|
||||||
|
*
|
||||||
|
* The optional `constructorOpt` argument accepts a function. If given, all frames
|
||||||
|
* above `constructorOpt`, including `constructorOpt`, will be omitted from the
|
||||||
|
* generated stack trace.
|
||||||
|
*
|
||||||
|
* The `constructorOpt` argument is useful for hiding implementation
|
||||||
|
* details of error generation from the user. For instance:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* function a() {
|
||||||
|
* b();
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* function b() {
|
||||||
|
* c();
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* function c() {
|
||||||
|
* // Create an error without stack trace to avoid calculating the stack trace twice.
|
||||||
|
* const { stackTraceLimit } = Error;
|
||||||
|
* Error.stackTraceLimit = 0;
|
||||||
|
* const error = new Error();
|
||||||
|
* Error.stackTraceLimit = stackTraceLimit;
|
||||||
|
*
|
||||||
|
* // Capture the stack trace above function b
|
||||||
|
* Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
|
||||||
|
* throw error;
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* a();
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
captureStackTrace(targetObject: object, constructorOpt?: Function): void;
|
||||||
|
/**
|
||||||
|
* @see https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
||||||
|
*/
|
||||||
|
prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
|
||||||
|
/**
|
||||||
|
* The `Error.stackTraceLimit` property specifies the number of stack frames
|
||||||
|
* collected by a stack trace (whether generated by `new Error().stack` or
|
||||||
|
* `Error.captureStackTrace(obj)`).
|
||||||
|
*
|
||||||
|
* The default value is `10` but may be set to any valid JavaScript number. Changes
|
||||||
|
* will affect any stack trace captured _after_ the value has been changed.
|
||||||
|
*
|
||||||
|
* If set to a non-number value, or set to a negative number, stack traces will
|
||||||
|
* not capture any frames.
|
||||||
|
*/
|
||||||
|
stackTraceLimit: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enable this API with the `--expose-gc` CLI flag.
|
||||||
|
*/
|
||||||
|
declare var gc: NodeJS.GCFunction | undefined;
|
||||||
|
|
||||||
|
declare namespace NodeJS {
|
||||||
|
interface CallSite {
|
||||||
|
getColumnNumber(): number | null;
|
||||||
|
getEnclosingColumnNumber(): number | null;
|
||||||
|
getEnclosingLineNumber(): number | null;
|
||||||
|
getEvalOrigin(): string | undefined;
|
||||||
|
getFileName(): string | null;
|
||||||
|
getFunction(): Function | undefined;
|
||||||
|
getFunctionName(): string | null;
|
||||||
|
getLineNumber(): number | null;
|
||||||
|
getMethodName(): string | null;
|
||||||
|
getPosition(): number;
|
||||||
|
getPromiseIndex(): number | null;
|
||||||
|
getScriptHash(): string;
|
||||||
|
getScriptNameOrSourceURL(): string | null;
|
||||||
|
getThis(): unknown;
|
||||||
|
getTypeName(): string | null;
|
||||||
|
isAsync(): boolean;
|
||||||
|
isConstructor(): boolean;
|
||||||
|
isEval(): boolean;
|
||||||
|
isNative(): boolean;
|
||||||
|
isPromiseAll(): boolean;
|
||||||
|
isToplevel(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ErrnoException extends Error {
|
||||||
|
errno?: number | undefined;
|
||||||
|
code?: string | undefined;
|
||||||
|
path?: string | undefined;
|
||||||
|
syscall?: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ReadableStream extends EventEmitter {
|
||||||
|
readable: boolean;
|
||||||
|
read(size?: number): string | Buffer;
|
||||||
|
setEncoding(encoding: BufferEncoding): this;
|
||||||
|
pause(): this;
|
||||||
|
resume(): this;
|
||||||
|
isPaused(): boolean;
|
||||||
|
pipe<T extends WritableStream>(destination: T, options?: { end?: boolean | undefined }): T;
|
||||||
|
unpipe(destination?: WritableStream): this;
|
||||||
|
unshift(chunk: string | Uint8Array, encoding?: BufferEncoding): void;
|
||||||
|
wrap(oldStream: ReadableStream): this;
|
||||||
|
[Symbol.asyncIterator](): AsyncIterableIterator<string | Buffer>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface WritableStream extends EventEmitter {
|
||||||
|
writable: boolean;
|
||||||
|
write(buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean;
|
||||||
|
write(str: string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean;
|
||||||
|
end(cb?: () => void): this;
|
||||||
|
end(data: string | Uint8Array, cb?: () => void): this;
|
||||||
|
end(str: string, encoding?: BufferEncoding, cb?: () => void): this;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ReadWriteStream extends ReadableStream, WritableStream {}
|
||||||
|
|
||||||
|
interface RefCounted {
|
||||||
|
ref(): this;
|
||||||
|
unref(): this;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Dict<T> {
|
||||||
|
[key: string]: T | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ReadOnlyDict<T> {
|
||||||
|
readonly [key: string]: T | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
type PartialOptions<T> = { [K in keyof T]?: T[K] | undefined };
|
||||||
|
|
||||||
|
interface GCFunction {
|
||||||
|
(minor?: boolean): void;
|
||||||
|
(options: NodeJS.GCOptions & { execution: "async" }): Promise<void>;
|
||||||
|
(options: NodeJS.GCOptions): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GCOptions {
|
||||||
|
execution?: "sync" | "async" | undefined;
|
||||||
|
flavor?: "regular" | "last-resort" | undefined;
|
||||||
|
type?: "major-snapshot" | "major" | "minor" | undefined;
|
||||||
|
filename?: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** An iterable iterator returned by the Node.js API. */
|
||||||
|
// Default TReturn/TNext in v20 is `any`, for compatibility with the previously-used IterableIterator.
|
||||||
|
interface Iterator<T, TReturn = any, TNext = any> extends IteratorObject<T, TReturn, TNext> {
|
||||||
|
[Symbol.iterator](): NodeJS.Iterator<T, TReturn, TNext>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** An async iterable iterator returned by the Node.js API. */
|
||||||
|
// Default TReturn/TNext in v20 is `any`, for compatibility with the previously-used AsyncIterableIterator.
|
||||||
|
interface AsyncIterator<T, TReturn = any, TNext = any> extends AsyncIteratorObject<T, TReturn, TNext> {
|
||||||
|
[Symbol.asyncIterator](): NodeJS.AsyncIterator<T, TReturn, TNext>;
|
||||||
|
}
|
||||||
|
}
|
||||||
+38
@@ -0,0 +1,38 @@
|
|||||||
|
export {}; // Make this a module
|
||||||
|
|
||||||
|
declare global {
|
||||||
|
namespace NodeJS {
|
||||||
|
type TypedArray<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike> =
|
||||||
|
| Uint8Array<TArrayBuffer>
|
||||||
|
| Uint8ClampedArray<TArrayBuffer>
|
||||||
|
| Uint16Array<TArrayBuffer>
|
||||||
|
| Uint32Array<TArrayBuffer>
|
||||||
|
| Int8Array<TArrayBuffer>
|
||||||
|
| Int16Array<TArrayBuffer>
|
||||||
|
| Int32Array<TArrayBuffer>
|
||||||
|
| BigUint64Array<TArrayBuffer>
|
||||||
|
| BigInt64Array<TArrayBuffer>
|
||||||
|
| Float32Array<TArrayBuffer>
|
||||||
|
| Float64Array<TArrayBuffer>;
|
||||||
|
type ArrayBufferView<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike> =
|
||||||
|
| TypedArray<TArrayBuffer>
|
||||||
|
| DataView<TArrayBuffer>;
|
||||||
|
|
||||||
|
// The following aliases are required to allow use of non-shared ArrayBufferViews in @types/node
|
||||||
|
// while maintaining compatibility with TS <=5.6.
|
||||||
|
type NonSharedUint8Array = Uint8Array<ArrayBuffer>;
|
||||||
|
type NonSharedUint8ClampedArray = Uint8ClampedArray<ArrayBuffer>;
|
||||||
|
type NonSharedUint16Array = Uint16Array<ArrayBuffer>;
|
||||||
|
type NonSharedUint32Array = Uint32Array<ArrayBuffer>;
|
||||||
|
type NonSharedInt8Array = Int8Array<ArrayBuffer>;
|
||||||
|
type NonSharedInt16Array = Int16Array<ArrayBuffer>;
|
||||||
|
type NonSharedInt32Array = Int32Array<ArrayBuffer>;
|
||||||
|
type NonSharedBigUint64Array = BigUint64Array<ArrayBuffer>;
|
||||||
|
type NonSharedBigInt64Array = BigInt64Array<ArrayBuffer>;
|
||||||
|
type NonSharedFloat32Array = Float32Array<ArrayBuffer>;
|
||||||
|
type NonSharedFloat64Array = Float64Array<ArrayBuffer>;
|
||||||
|
type NonSharedDataView = DataView<ArrayBuffer>;
|
||||||
|
type NonSharedTypedArray = TypedArray<ArrayBuffer>;
|
||||||
|
type NonSharedArrayBufferView = ArrayBufferView<ArrayBuffer>;
|
||||||
|
}
|
||||||
|
}
|
||||||
+2049
File diff suppressed because it is too large
Load Diff
+2631
File diff suppressed because it is too large
Load Diff
+578
@@ -0,0 +1,578 @@
|
|||||||
|
/**
|
||||||
|
* HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
|
||||||
|
* separate module.
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/https.js)
|
||||||
|
*/
|
||||||
|
declare module "https" {
|
||||||
|
import { NonSharedBuffer } from "node:buffer";
|
||||||
|
import { Duplex } from "node:stream";
|
||||||
|
import * as tls from "node:tls";
|
||||||
|
import * as http from "node:http";
|
||||||
|
import { URL } from "node:url";
|
||||||
|
interface ServerOptions<
|
||||||
|
Request extends typeof http.IncomingMessage = typeof http.IncomingMessage,
|
||||||
|
Response extends typeof http.ServerResponse<InstanceType<Request>> = typeof http.ServerResponse,
|
||||||
|
> extends http.ServerOptions<Request, Response>, tls.TlsOptions {}
|
||||||
|
interface RequestOptions extends http.RequestOptions, tls.SecureContextOptions {
|
||||||
|
checkServerIdentity?: typeof tls.checkServerIdentity | undefined;
|
||||||
|
rejectUnauthorized?: boolean | undefined; // Defaults to true
|
||||||
|
servername?: string | undefined; // SNI TLS Extension
|
||||||
|
}
|
||||||
|
interface AgentOptions extends http.AgentOptions, tls.ConnectionOptions {
|
||||||
|
rejectUnauthorized?: boolean | undefined;
|
||||||
|
maxCachedSessions?: number | undefined;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* An `Agent` object for HTTPS similar to `http.Agent`. See {@link request} for more information.
|
||||||
|
* @since v0.4.5
|
||||||
|
*/
|
||||||
|
class Agent extends http.Agent {
|
||||||
|
constructor(options?: AgentOptions);
|
||||||
|
options: AgentOptions;
|
||||||
|
createConnection(
|
||||||
|
options: RequestOptions,
|
||||||
|
callback?: (err: Error | null, stream: Duplex) => void,
|
||||||
|
): Duplex | null | undefined;
|
||||||
|
getName(options?: RequestOptions): string;
|
||||||
|
}
|
||||||
|
interface Server<
|
||||||
|
Request extends typeof http.IncomingMessage = typeof http.IncomingMessage,
|
||||||
|
Response extends typeof http.ServerResponse<InstanceType<Request>> = typeof http.ServerResponse,
|
||||||
|
> extends http.Server<Request, Response> {}
|
||||||
|
/**
|
||||||
|
* See `http.Server` for more information.
|
||||||
|
* @since v0.3.4
|
||||||
|
*/
|
||||||
|
class Server<
|
||||||
|
Request extends typeof http.IncomingMessage = typeof http.IncomingMessage,
|
||||||
|
Response extends typeof http.ServerResponse<InstanceType<Request>> = typeof http.ServerResponse,
|
||||||
|
> extends tls.Server {
|
||||||
|
constructor(requestListener?: http.RequestListener<Request, Response>);
|
||||||
|
constructor(
|
||||||
|
options: ServerOptions<Request, Response>,
|
||||||
|
requestListener?: http.RequestListener<Request, Response>,
|
||||||
|
);
|
||||||
|
/**
|
||||||
|
* Closes all connections connected to this server.
|
||||||
|
* @since v18.2.0
|
||||||
|
*/
|
||||||
|
closeAllConnections(): void;
|
||||||
|
/**
|
||||||
|
* Closes all connections connected to this server which are not sending a request or waiting for a response.
|
||||||
|
* @since v18.2.0
|
||||||
|
*/
|
||||||
|
closeIdleConnections(): void;
|
||||||
|
addListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
addListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
addListener(
|
||||||
|
event: "newSession",
|
||||||
|
listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
|
||||||
|
): this;
|
||||||
|
addListener(
|
||||||
|
event: "OCSPRequest",
|
||||||
|
listener: (
|
||||||
|
certificate: NonSharedBuffer,
|
||||||
|
issuer: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, resp: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
addListener(
|
||||||
|
event: "resumeSession",
|
||||||
|
listener: (
|
||||||
|
sessionId: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, sessionData: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
addListener(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
addListener(event: "close", listener: () => void): this;
|
||||||
|
addListener(event: "connection", listener: (socket: Duplex) => void): this;
|
||||||
|
addListener(event: "error", listener: (err: Error) => void): this;
|
||||||
|
addListener(event: "listening", listener: () => void): this;
|
||||||
|
addListener(event: "checkContinue", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
addListener(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
addListener(event: "clientError", listener: (err: Error, socket: Duplex) => void): this;
|
||||||
|
addListener(
|
||||||
|
event: "connect",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
addListener(event: "request", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
addListener(
|
||||||
|
event: "upgrade",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
emit(event: string, ...args: any[]): boolean;
|
||||||
|
emit(event: "keylog", line: NonSharedBuffer, tlsSocket: tls.TLSSocket): boolean;
|
||||||
|
emit(
|
||||||
|
event: "newSession",
|
||||||
|
sessionId: NonSharedBuffer,
|
||||||
|
sessionData: NonSharedBuffer,
|
||||||
|
callback: () => void,
|
||||||
|
): boolean;
|
||||||
|
emit(
|
||||||
|
event: "OCSPRequest",
|
||||||
|
certificate: NonSharedBuffer,
|
||||||
|
issuer: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, resp: Buffer | null) => void,
|
||||||
|
): boolean;
|
||||||
|
emit(
|
||||||
|
event: "resumeSession",
|
||||||
|
sessionId: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, sessionData: Buffer | null) => void,
|
||||||
|
): boolean;
|
||||||
|
emit(event: "secureConnection", tlsSocket: tls.TLSSocket): boolean;
|
||||||
|
emit(event: "tlsClientError", err: Error, tlsSocket: tls.TLSSocket): boolean;
|
||||||
|
emit(event: "close"): boolean;
|
||||||
|
emit(event: "connection", socket: Duplex): boolean;
|
||||||
|
emit(event: "error", err: Error): boolean;
|
||||||
|
emit(event: "listening"): boolean;
|
||||||
|
emit(
|
||||||
|
event: "checkContinue",
|
||||||
|
req: InstanceType<Request>,
|
||||||
|
res: InstanceType<Response>,
|
||||||
|
): boolean;
|
||||||
|
emit(
|
||||||
|
event: "checkExpectation",
|
||||||
|
req: InstanceType<Request>,
|
||||||
|
res: InstanceType<Response>,
|
||||||
|
): boolean;
|
||||||
|
emit(event: "clientError", err: Error, socket: Duplex): boolean;
|
||||||
|
emit(event: "connect", req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer): boolean;
|
||||||
|
emit(
|
||||||
|
event: "request",
|
||||||
|
req: InstanceType<Request>,
|
||||||
|
res: InstanceType<Response>,
|
||||||
|
): boolean;
|
||||||
|
emit(event: "upgrade", req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer): boolean;
|
||||||
|
on(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
on(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
on(
|
||||||
|
event: "newSession",
|
||||||
|
listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
|
||||||
|
): this;
|
||||||
|
on(
|
||||||
|
event: "OCSPRequest",
|
||||||
|
listener: (
|
||||||
|
certificate: NonSharedBuffer,
|
||||||
|
issuer: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, resp: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
on(
|
||||||
|
event: "resumeSession",
|
||||||
|
listener: (
|
||||||
|
sessionId: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, sessionData: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
on(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
on(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
on(event: "close", listener: () => void): this;
|
||||||
|
on(event: "connection", listener: (socket: Duplex) => void): this;
|
||||||
|
on(event: "error", listener: (err: Error) => void): this;
|
||||||
|
on(event: "listening", listener: () => void): this;
|
||||||
|
on(event: "checkContinue", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
on(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
on(event: "clientError", listener: (err: Error, socket: Duplex) => void): this;
|
||||||
|
on(
|
||||||
|
event: "connect",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
on(event: "request", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
on(
|
||||||
|
event: "upgrade",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
once(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
once(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
once(
|
||||||
|
event: "newSession",
|
||||||
|
listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
|
||||||
|
): this;
|
||||||
|
once(
|
||||||
|
event: "OCSPRequest",
|
||||||
|
listener: (
|
||||||
|
certificate: NonSharedBuffer,
|
||||||
|
issuer: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, resp: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
once(
|
||||||
|
event: "resumeSession",
|
||||||
|
listener: (
|
||||||
|
sessionId: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, sessionData: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
once(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
once(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
once(event: "close", listener: () => void): this;
|
||||||
|
once(event: "connection", listener: (socket: Duplex) => void): this;
|
||||||
|
once(event: "error", listener: (err: Error) => void): this;
|
||||||
|
once(event: "listening", listener: () => void): this;
|
||||||
|
once(event: "checkContinue", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
once(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
once(event: "clientError", listener: (err: Error, socket: Duplex) => void): this;
|
||||||
|
once(
|
||||||
|
event: "connect",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
once(event: "request", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
once(
|
||||||
|
event: "upgrade",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
prependListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
prependListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
prependListener(
|
||||||
|
event: "newSession",
|
||||||
|
listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
|
||||||
|
): this;
|
||||||
|
prependListener(
|
||||||
|
event: "OCSPRequest",
|
||||||
|
listener: (
|
||||||
|
certificate: NonSharedBuffer,
|
||||||
|
issuer: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, resp: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
prependListener(
|
||||||
|
event: "resumeSession",
|
||||||
|
listener: (
|
||||||
|
sessionId: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, sessionData: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
prependListener(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
prependListener(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
prependListener(event: "close", listener: () => void): this;
|
||||||
|
prependListener(event: "connection", listener: (socket: Duplex) => void): this;
|
||||||
|
prependListener(event: "error", listener: (err: Error) => void): this;
|
||||||
|
prependListener(event: "listening", listener: () => void): this;
|
||||||
|
prependListener(event: "checkContinue", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
prependListener(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
prependListener(event: "clientError", listener: (err: Error, socket: Duplex) => void): this;
|
||||||
|
prependListener(
|
||||||
|
event: "connect",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
prependListener(event: "request", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
prependListener(
|
||||||
|
event: "upgrade",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
|
||||||
|
prependOnceListener(event: "keylog", listener: (line: NonSharedBuffer, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
prependOnceListener(
|
||||||
|
event: "newSession",
|
||||||
|
listener: (sessionId: NonSharedBuffer, sessionData: NonSharedBuffer, callback: () => void) => void,
|
||||||
|
): this;
|
||||||
|
prependOnceListener(
|
||||||
|
event: "OCSPRequest",
|
||||||
|
listener: (
|
||||||
|
certificate: NonSharedBuffer,
|
||||||
|
issuer: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, resp: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
prependOnceListener(
|
||||||
|
event: "resumeSession",
|
||||||
|
listener: (
|
||||||
|
sessionId: NonSharedBuffer,
|
||||||
|
callback: (err: Error | null, sessionData: Buffer | null) => void,
|
||||||
|
) => void,
|
||||||
|
): this;
|
||||||
|
prependOnceListener(event: "secureConnection", listener: (tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
prependOnceListener(event: "tlsClientError", listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this;
|
||||||
|
prependOnceListener(event: "close", listener: () => void): this;
|
||||||
|
prependOnceListener(event: "connection", listener: (socket: Duplex) => void): this;
|
||||||
|
prependOnceListener(event: "error", listener: (err: Error) => void): this;
|
||||||
|
prependOnceListener(event: "listening", listener: () => void): this;
|
||||||
|
prependOnceListener(event: "checkContinue", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
prependOnceListener(event: "checkExpectation", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
prependOnceListener(event: "clientError", listener: (err: Error, socket: Duplex) => void): this;
|
||||||
|
prependOnceListener(
|
||||||
|
event: "connect",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
prependOnceListener(event: "request", listener: http.RequestListener<Request, Response>): this;
|
||||||
|
prependOnceListener(
|
||||||
|
event: "upgrade",
|
||||||
|
listener: (req: InstanceType<Request>, socket: Duplex, head: NonSharedBuffer) => void,
|
||||||
|
): this;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* ```js
|
||||||
|
* // curl -k https://localhost:8000/
|
||||||
|
* import https from 'node:https';
|
||||||
|
* import fs from 'node:fs';
|
||||||
|
*
|
||||||
|
* const options = {
|
||||||
|
* key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
|
||||||
|
* cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* https.createServer(options, (req, res) => {
|
||||||
|
* res.writeHead(200);
|
||||||
|
* res.end('hello world\n');
|
||||||
|
* }).listen(8000);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Or
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import https from 'node:https';
|
||||||
|
* import fs from 'node:fs';
|
||||||
|
*
|
||||||
|
* const options = {
|
||||||
|
* pfx: fs.readFileSync('test/fixtures/test_cert.pfx'),
|
||||||
|
* passphrase: 'sample',
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* https.createServer(options, (req, res) => {
|
||||||
|
* res.writeHead(200);
|
||||||
|
* res.end('hello world\n');
|
||||||
|
* }).listen(8000);
|
||||||
|
* ```
|
||||||
|
* @since v0.3.4
|
||||||
|
* @param options Accepts `options` from `createServer`, `createSecureContext` and `createServer`.
|
||||||
|
* @param requestListener A listener to be added to the `'request'` event.
|
||||||
|
*/
|
||||||
|
function createServer<
|
||||||
|
Request extends typeof http.IncomingMessage = typeof http.IncomingMessage,
|
||||||
|
Response extends typeof http.ServerResponse<InstanceType<Request>> = typeof http.ServerResponse,
|
||||||
|
>(requestListener?: http.RequestListener<Request, Response>): Server<Request, Response>;
|
||||||
|
function createServer<
|
||||||
|
Request extends typeof http.IncomingMessage = typeof http.IncomingMessage,
|
||||||
|
Response extends typeof http.ServerResponse<InstanceType<Request>> = typeof http.ServerResponse,
|
||||||
|
>(
|
||||||
|
options: ServerOptions<Request, Response>,
|
||||||
|
requestListener?: http.RequestListener<Request, Response>,
|
||||||
|
): Server<Request, Response>;
|
||||||
|
/**
|
||||||
|
* Makes a request to a secure web server.
|
||||||
|
*
|
||||||
|
* The following additional `options` from `tls.connect()` are also accepted: `ca`, `cert`, `ciphers`, `clientCertEngine`, `crl`, `dhparam`, `ecdhCurve`, `honorCipherOrder`, `key`, `passphrase`,
|
||||||
|
* `pfx`, `rejectUnauthorized`, `secureOptions`, `secureProtocol`, `servername`, `sessionIdContext`, `highWaterMark`.
|
||||||
|
*
|
||||||
|
* `options` can be an object, a string, or a `URL` object. If `options` is a
|
||||||
|
* string, it is automatically parsed with `new URL()`. If it is a `URL` object, it will be automatically converted to an ordinary `options` object.
|
||||||
|
*
|
||||||
|
* `https.request()` returns an instance of the `http.ClientRequest` class. The `ClientRequest` instance is a writable stream. If one needs to
|
||||||
|
* upload a file with a POST request, then write to the `ClientRequest` object.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import https from 'node:https';
|
||||||
|
*
|
||||||
|
* const options = {
|
||||||
|
* hostname: 'encrypted.google.com',
|
||||||
|
* port: 443,
|
||||||
|
* path: '/',
|
||||||
|
* method: 'GET',
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* const req = https.request(options, (res) => {
|
||||||
|
* console.log('statusCode:', res.statusCode);
|
||||||
|
* console.log('headers:', res.headers);
|
||||||
|
*
|
||||||
|
* res.on('data', (d) => {
|
||||||
|
* process.stdout.write(d);
|
||||||
|
* });
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* req.on('error', (e) => {
|
||||||
|
* console.error(e);
|
||||||
|
* });
|
||||||
|
* req.end();
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Example using options from `tls.connect()`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const options = {
|
||||||
|
* hostname: 'encrypted.google.com',
|
||||||
|
* port: 443,
|
||||||
|
* path: '/',
|
||||||
|
* method: 'GET',
|
||||||
|
* key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
|
||||||
|
* cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),
|
||||||
|
* };
|
||||||
|
* options.agent = new https.Agent(options);
|
||||||
|
*
|
||||||
|
* const req = https.request(options, (res) => {
|
||||||
|
* // ...
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Alternatively, opt out of connection pooling by not using an `Agent`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const options = {
|
||||||
|
* hostname: 'encrypted.google.com',
|
||||||
|
* port: 443,
|
||||||
|
* path: '/',
|
||||||
|
* method: 'GET',
|
||||||
|
* key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
|
||||||
|
* cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),
|
||||||
|
* agent: false,
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* const req = https.request(options, (res) => {
|
||||||
|
* // ...
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Example using a `URL` as `options`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* const options = new URL('https://abc:xyz@example.com');
|
||||||
|
*
|
||||||
|
* const req = https.request(options, (res) => {
|
||||||
|
* // ...
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Example pinning on certificate fingerprint, or the public key (similar to`pin-sha256`):
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import tls from 'node:tls';
|
||||||
|
* import https from 'node:https';
|
||||||
|
* import crypto from 'node:crypto';
|
||||||
|
*
|
||||||
|
* function sha256(s) {
|
||||||
|
* return crypto.createHash('sha256').update(s).digest('base64');
|
||||||
|
* }
|
||||||
|
* const options = {
|
||||||
|
* hostname: 'github.com',
|
||||||
|
* port: 443,
|
||||||
|
* path: '/',
|
||||||
|
* method: 'GET',
|
||||||
|
* checkServerIdentity: function(host, cert) {
|
||||||
|
* // Make sure the certificate is issued to the host we are connected to
|
||||||
|
* const err = tls.checkServerIdentity(host, cert);
|
||||||
|
* if (err) {
|
||||||
|
* return err;
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* // Pin the public key, similar to HPKP pin-sha256 pinning
|
||||||
|
* const pubkey256 = 'pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU=';
|
||||||
|
* if (sha256(cert.pubkey) !== pubkey256) {
|
||||||
|
* const msg = 'Certificate verification error: ' +
|
||||||
|
* `The public key of '${cert.subject.CN}' ` +
|
||||||
|
* 'does not match our pinned fingerprint';
|
||||||
|
* return new Error(msg);
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* // Pin the exact certificate, rather than the pub key
|
||||||
|
* const cert256 = '25:FE:39:32:D9:63:8C:8A:FC:A1:9A:29:87:' +
|
||||||
|
* 'D8:3E:4C:1D:98:DB:71:E4:1A:48:03:98:EA:22:6A:BD:8B:93:16';
|
||||||
|
* if (cert.fingerprint256 !== cert256) {
|
||||||
|
* const msg = 'Certificate verification error: ' +
|
||||||
|
* `The certificate of '${cert.subject.CN}' ` +
|
||||||
|
* 'does not match our pinned fingerprint';
|
||||||
|
* return new Error(msg);
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* // This loop is informational only.
|
||||||
|
* // Print the certificate and public key fingerprints of all certs in the
|
||||||
|
* // chain. Its common to pin the public key of the issuer on the public
|
||||||
|
* // internet, while pinning the public key of the service in sensitive
|
||||||
|
* // environments.
|
||||||
|
* do {
|
||||||
|
* console.log('Subject Common Name:', cert.subject.CN);
|
||||||
|
* console.log(' Certificate SHA256 fingerprint:', cert.fingerprint256);
|
||||||
|
*
|
||||||
|
* hash = crypto.createHash('sha256');
|
||||||
|
* console.log(' Public key ping-sha256:', sha256(cert.pubkey));
|
||||||
|
*
|
||||||
|
* lastprint256 = cert.fingerprint256;
|
||||||
|
* cert = cert.issuerCertificate;
|
||||||
|
* } while (cert.fingerprint256 !== lastprint256);
|
||||||
|
*
|
||||||
|
* },
|
||||||
|
* };
|
||||||
|
*
|
||||||
|
* options.agent = new https.Agent(options);
|
||||||
|
* const req = https.request(options, (res) => {
|
||||||
|
* console.log('All OK. Server matched our pinned cert or public key');
|
||||||
|
* console.log('statusCode:', res.statusCode);
|
||||||
|
* // Print the HPKP values
|
||||||
|
* console.log('headers:', res.headers['public-key-pins']);
|
||||||
|
*
|
||||||
|
* res.on('data', (d) => {});
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* req.on('error', (e) => {
|
||||||
|
* console.error(e.message);
|
||||||
|
* });
|
||||||
|
* req.end();
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* Outputs for example:
|
||||||
|
*
|
||||||
|
* ```text
|
||||||
|
* Subject Common Name: github.com
|
||||||
|
* Certificate SHA256 fingerprint: 25:FE:39:32:D9:63:8C:8A:FC:A1:9A:29:87:D8:3E:4C:1D:98:DB:71:E4:1A:48:03:98:EA:22:6A:BD:8B:93:16
|
||||||
|
* Public key ping-sha256: pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU=
|
||||||
|
* Subject Common Name: DigiCert SHA2 Extended Validation Server CA
|
||||||
|
* Certificate SHA256 fingerprint: 40:3E:06:2A:26:53:05:91:13:28:5B:AF:80:A0:D4:AE:42:2C:84:8C:9F:78:FA:D0:1F:C9:4B:C5:B8:7F:EF:1A
|
||||||
|
* Public key ping-sha256: RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho=
|
||||||
|
* Subject Common Name: DigiCert High Assurance EV Root CA
|
||||||
|
* Certificate SHA256 fingerprint: 74:31:E5:F4:C3:C1:CE:46:90:77:4F:0B:61:E0:54:40:88:3B:A9:A0:1E:D0:0B:A6:AB:D7:80:6E:D3:B1:18:CF
|
||||||
|
* Public key ping-sha256: WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18=
|
||||||
|
* All OK. Server matched our pinned cert or public key
|
||||||
|
* statusCode: 200
|
||||||
|
* headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; pin-sha256="RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho=";
|
||||||
|
* pin-sha256="k2v657xBsOVe1PQRwOsHsw3bsGT2VzIqz5K+59sNQws="; pin-sha256="K87oWBWM9UZfyddvDfoxL+8lpNyoUB2ptGtn0fv6G2Q="; pin-sha256="IQBnNBEiFuhj+8x6X8XLgh01V9Ic5/V3IRQLNFFc7v4=";
|
||||||
|
* pin-sha256="iie1VXtL7HzAMF+/PVPR9xzT80kQxdZeJ+zduCB3uj0="; pin-sha256="LvRiGEjRqfzurezaWuj8Wie2gyHMrW5Q06LspMnox7A="; includeSubDomains
|
||||||
|
* ```
|
||||||
|
* @since v0.3.6
|
||||||
|
* @param options Accepts all `options` from `request`, with some differences in default values:
|
||||||
|
*/
|
||||||
|
function request(
|
||||||
|
options: RequestOptions | string | URL,
|
||||||
|
callback?: (res: http.IncomingMessage) => void,
|
||||||
|
): http.ClientRequest;
|
||||||
|
function request(
|
||||||
|
url: string | URL,
|
||||||
|
options: RequestOptions,
|
||||||
|
callback?: (res: http.IncomingMessage) => void,
|
||||||
|
): http.ClientRequest;
|
||||||
|
/**
|
||||||
|
* Like `http.get()` but for HTTPS.
|
||||||
|
*
|
||||||
|
* `options` can be an object, a string, or a `URL` object. If `options` is a
|
||||||
|
* string, it is automatically parsed with `new URL()`. If it is a `URL` object, it will be automatically converted to an ordinary `options` object.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import https from 'node:https';
|
||||||
|
*
|
||||||
|
* https.get('https://encrypted.google.com/', (res) => {
|
||||||
|
* console.log('statusCode:', res.statusCode);
|
||||||
|
* console.log('headers:', res.headers);
|
||||||
|
*
|
||||||
|
* res.on('data', (d) => {
|
||||||
|
* process.stdout.write(d);
|
||||||
|
* });
|
||||||
|
*
|
||||||
|
* }).on('error', (e) => {
|
||||||
|
* console.error(e);
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v0.3.6
|
||||||
|
* @param options Accepts the same `options` as {@link request}, with the `method` always set to `GET`.
|
||||||
|
*/
|
||||||
|
function get(
|
||||||
|
options: RequestOptions | string | URL,
|
||||||
|
callback?: (res: http.IncomingMessage) => void,
|
||||||
|
): http.ClientRequest;
|
||||||
|
function get(
|
||||||
|
url: string | URL,
|
||||||
|
options: RequestOptions,
|
||||||
|
callback?: (res: http.IncomingMessage) => void,
|
||||||
|
): http.ClientRequest;
|
||||||
|
let globalAgent: Agent;
|
||||||
|
}
|
||||||
|
declare module "node:https" {
|
||||||
|
export * from "https";
|
||||||
|
}
|
||||||
+93
@@ -0,0 +1,93 @@
|
|||||||
|
/**
|
||||||
|
* License for programmatically and manually incorporated
|
||||||
|
* documentation aka. `JSDoc` from https://github.com/nodejs/node/tree/master/doc
|
||||||
|
*
|
||||||
|
* Copyright Node.js contributors. All rights reserved.
|
||||||
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
* of this software and associated documentation files (the "Software"), to
|
||||||
|
* deal in the Software without restriction, including without limitation the
|
||||||
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
||||||
|
* sell copies of the Software, and to permit persons to whom the Software is
|
||||||
|
* furnished to do so, subject to the following conditions:
|
||||||
|
*
|
||||||
|
* The above copyright notice and this permission notice shall be included in
|
||||||
|
* all copies or substantial portions of the Software.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||||||
|
* IN THE SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// NOTE: These definitions support Node.js and TypeScript 5.7+.
|
||||||
|
|
||||||
|
// Reference required TypeScript libs:
|
||||||
|
/// <reference lib="es2020" />
|
||||||
|
|
||||||
|
// TypeScript backwards-compatibility definitions:
|
||||||
|
/// <reference path="compatibility/index.d.ts" />
|
||||||
|
|
||||||
|
// Definitions specific to TypeScript 5.7+:
|
||||||
|
/// <reference path="globals.typedarray.d.ts" />
|
||||||
|
/// <reference path="buffer.buffer.d.ts" />
|
||||||
|
|
||||||
|
// Definitions for Node.js modules that are not specific to any version of TypeScript:
|
||||||
|
/// <reference path="globals.d.ts" />
|
||||||
|
/// <reference path="web-globals/abortcontroller.d.ts" />
|
||||||
|
/// <reference path="web-globals/domexception.d.ts" />
|
||||||
|
/// <reference path="web-globals/events.d.ts" />
|
||||||
|
/// <reference path="web-globals/fetch.d.ts" />
|
||||||
|
/// <reference path="assert.d.ts" />
|
||||||
|
/// <reference path="assert/strict.d.ts" />
|
||||||
|
/// <reference path="async_hooks.d.ts" />
|
||||||
|
/// <reference path="buffer.d.ts" />
|
||||||
|
/// <reference path="child_process.d.ts" />
|
||||||
|
/// <reference path="cluster.d.ts" />
|
||||||
|
/// <reference path="console.d.ts" />
|
||||||
|
/// <reference path="constants.d.ts" />
|
||||||
|
/// <reference path="crypto.d.ts" />
|
||||||
|
/// <reference path="dgram.d.ts" />
|
||||||
|
/// <reference path="diagnostics_channel.d.ts" />
|
||||||
|
/// <reference path="dns.d.ts" />
|
||||||
|
/// <reference path="dns/promises.d.ts" />
|
||||||
|
/// <reference path="domain.d.ts" />
|
||||||
|
/// <reference path="events.d.ts" />
|
||||||
|
/// <reference path="fs.d.ts" />
|
||||||
|
/// <reference path="fs/promises.d.ts" />
|
||||||
|
/// <reference path="http.d.ts" />
|
||||||
|
/// <reference path="http2.d.ts" />
|
||||||
|
/// <reference path="https.d.ts" />
|
||||||
|
/// <reference path="inspector.generated.d.ts" />
|
||||||
|
/// <reference path="module.d.ts" />
|
||||||
|
/// <reference path="net.d.ts" />
|
||||||
|
/// <reference path="os.d.ts" />
|
||||||
|
/// <reference path="path.d.ts" />
|
||||||
|
/// <reference path="perf_hooks.d.ts" />
|
||||||
|
/// <reference path="process.d.ts" />
|
||||||
|
/// <reference path="punycode.d.ts" />
|
||||||
|
/// <reference path="querystring.d.ts" />
|
||||||
|
/// <reference path="readline.d.ts" />
|
||||||
|
/// <reference path="readline/promises.d.ts" />
|
||||||
|
/// <reference path="repl.d.ts" />
|
||||||
|
/// <reference path="sea.d.ts" />
|
||||||
|
/// <reference path="stream.d.ts" />
|
||||||
|
/// <reference path="stream/promises.d.ts" />
|
||||||
|
/// <reference path="stream/consumers.d.ts" />
|
||||||
|
/// <reference path="stream/web.d.ts" />
|
||||||
|
/// <reference path="string_decoder.d.ts" />
|
||||||
|
/// <reference path="test.d.ts" />
|
||||||
|
/// <reference path="timers.d.ts" />
|
||||||
|
/// <reference path="timers/promises.d.ts" />
|
||||||
|
/// <reference path="tls.d.ts" />
|
||||||
|
/// <reference path="trace_events.d.ts" />
|
||||||
|
/// <reference path="tty.d.ts" />
|
||||||
|
/// <reference path="url.d.ts" />
|
||||||
|
/// <reference path="util.d.ts" />
|
||||||
|
/// <reference path="v8.d.ts" />
|
||||||
|
/// <reference path="vm.d.ts" />
|
||||||
|
/// <reference path="wasi.d.ts" />
|
||||||
|
/// <reference path="worker_threads.d.ts" />
|
||||||
|
/// <reference path="zlib.d.ts" />
|
||||||
+3966
File diff suppressed because it is too large
Load Diff
+539
@@ -0,0 +1,539 @@
|
|||||||
|
/**
|
||||||
|
* @since v0.3.7
|
||||||
|
*/
|
||||||
|
declare module "module" {
|
||||||
|
import { URL } from "node:url";
|
||||||
|
import { MessagePort } from "node:worker_threads";
|
||||||
|
class Module {
|
||||||
|
constructor(id: string, parent?: Module);
|
||||||
|
}
|
||||||
|
interface Module extends NodeJS.Module {}
|
||||||
|
namespace Module {
|
||||||
|
export { Module };
|
||||||
|
}
|
||||||
|
namespace Module {
|
||||||
|
/**
|
||||||
|
* A list of the names of all modules provided by Node.js. Can be used to verify
|
||||||
|
* if a module is maintained by a third party or not.
|
||||||
|
*
|
||||||
|
* Note: the list doesn't contain prefix-only modules like `node:test`.
|
||||||
|
* @since v9.3.0, v8.10.0, v6.13.0
|
||||||
|
*/
|
||||||
|
const builtinModules: readonly string[];
|
||||||
|
/**
|
||||||
|
* @since v12.2.0
|
||||||
|
* @param path Filename to be used to construct the require
|
||||||
|
* function. Must be a file URL object, file URL string, or absolute path
|
||||||
|
* string.
|
||||||
|
*/
|
||||||
|
function createRequire(path: string | URL): NodeJS.Require;
|
||||||
|
/**
|
||||||
|
* @since v18.6.0, v16.17.0
|
||||||
|
*/
|
||||||
|
function isBuiltin(moduleName: string): boolean;
|
||||||
|
interface RegisterOptions<Data> {
|
||||||
|
/**
|
||||||
|
* If you want to resolve `specifier` relative to a
|
||||||
|
* base URL, such as `import.meta.url`, you can pass that URL here. This
|
||||||
|
* property is ignored if the `parentURL` is supplied as the second argument.
|
||||||
|
* @default 'data:'
|
||||||
|
*/
|
||||||
|
parentURL?: string | URL | undefined;
|
||||||
|
/**
|
||||||
|
* Any arbitrary, cloneable JavaScript value to pass into the
|
||||||
|
* {@link initialize} hook.
|
||||||
|
*/
|
||||||
|
data?: Data | undefined;
|
||||||
|
/**
|
||||||
|
* [Transferable objects](https://nodejs.org/docs/latest-v20.x/api/worker_threads.html#portpostmessagevalue-transferlist)
|
||||||
|
* to be passed into the `initialize` hook.
|
||||||
|
*/
|
||||||
|
transferList?: any[] | undefined;
|
||||||
|
}
|
||||||
|
/* eslint-disable @definitelytyped/no-unnecessary-generics */
|
||||||
|
/**
|
||||||
|
* Register a module that exports hooks that customize Node.js module
|
||||||
|
* resolution and loading behavior. See
|
||||||
|
* [Customization hooks](https://nodejs.org/docs/latest-v20.x/api/module.html#customization-hooks).
|
||||||
|
* @since v20.6.0, v18.19.0
|
||||||
|
* @param specifier Customization hooks to be registered; this should be
|
||||||
|
* the same string that would be passed to `import()`, except that if it is
|
||||||
|
* relative, it is resolved relative to `parentURL`.
|
||||||
|
* @param parentURL f you want to resolve `specifier` relative to a base
|
||||||
|
* URL, such as `import.meta.url`, you can pass that URL here.
|
||||||
|
*/
|
||||||
|
function register<Data = any>(
|
||||||
|
specifier: string | URL,
|
||||||
|
parentURL?: string | URL,
|
||||||
|
options?: RegisterOptions<Data>,
|
||||||
|
): void;
|
||||||
|
function register<Data = any>(specifier: string | URL, options?: RegisterOptions<Data>): void;
|
||||||
|
/* eslint-enable @definitelytyped/no-unnecessary-generics */
|
||||||
|
/**
|
||||||
|
* The `module.syncBuiltinESMExports()` method updates all the live bindings for
|
||||||
|
* builtin `ES Modules` to match the properties of the `CommonJS` exports. It
|
||||||
|
* does not add or remove exported names from the `ES Modules`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import fs from 'node:fs';
|
||||||
|
* import assert from 'node:assert';
|
||||||
|
* import { syncBuiltinESMExports } from 'node:module';
|
||||||
|
*
|
||||||
|
* fs.readFile = newAPI;
|
||||||
|
*
|
||||||
|
* delete fs.readFileSync;
|
||||||
|
*
|
||||||
|
* function newAPI() {
|
||||||
|
* // ...
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* fs.newAPI = newAPI;
|
||||||
|
*
|
||||||
|
* syncBuiltinESMExports();
|
||||||
|
*
|
||||||
|
* import('node:fs').then((esmFS) => {
|
||||||
|
* // It syncs the existing readFile property with the new value
|
||||||
|
* assert.strictEqual(esmFS.readFile, newAPI);
|
||||||
|
* // readFileSync has been deleted from the required fs
|
||||||
|
* assert.strictEqual('readFileSync' in fs, false);
|
||||||
|
* // syncBuiltinESMExports() does not remove readFileSync from esmFS
|
||||||
|
* assert.strictEqual('readFileSync' in esmFS, true);
|
||||||
|
* // syncBuiltinESMExports() does not add names
|
||||||
|
* assert.strictEqual(esmFS.newAPI, undefined);
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @since v12.12.0
|
||||||
|
*/
|
||||||
|
function syncBuiltinESMExports(): void;
|
||||||
|
/** @deprecated Use `ImportAttributes` instead */
|
||||||
|
interface ImportAssertions extends ImportAttributes {}
|
||||||
|
interface ImportAttributes extends NodeJS.Dict<string> {
|
||||||
|
type?: string | undefined;
|
||||||
|
}
|
||||||
|
type ModuleFormat = "builtin" | "commonjs" | "json" | "module" | "wasm";
|
||||||
|
type ModuleSource = string | ArrayBuffer | NodeJS.TypedArray;
|
||||||
|
/**
|
||||||
|
* The `initialize` hook provides a way to define a custom function that runs in
|
||||||
|
* the hooks thread when the hooks module is initialized. Initialization happens
|
||||||
|
* when the hooks module is registered via {@link register}.
|
||||||
|
*
|
||||||
|
* This hook can receive data from a {@link register} invocation, including
|
||||||
|
* ports and other transferable objects. The return value of `initialize` can be a
|
||||||
|
* `Promise`, in which case it will be awaited before the main application thread
|
||||||
|
* execution resumes.
|
||||||
|
*/
|
||||||
|
type InitializeHook<Data = any> = (data: Data) => void | Promise<void>;
|
||||||
|
interface ResolveHookContext {
|
||||||
|
/**
|
||||||
|
* Export conditions of the relevant `package.json`
|
||||||
|
*/
|
||||||
|
conditions: string[];
|
||||||
|
/**
|
||||||
|
* @deprecated Use `importAttributes` instead
|
||||||
|
*/
|
||||||
|
importAssertions: ImportAttributes;
|
||||||
|
/**
|
||||||
|
* An object whose key-value pairs represent the assertions for the module to import
|
||||||
|
*/
|
||||||
|
importAttributes: ImportAttributes;
|
||||||
|
/**
|
||||||
|
* The module importing this one, or undefined if this is the Node.js entry point
|
||||||
|
*/
|
||||||
|
parentURL: string | undefined;
|
||||||
|
}
|
||||||
|
interface ResolveFnOutput {
|
||||||
|
/**
|
||||||
|
* A hint to the load hook (it might be ignored)
|
||||||
|
*/
|
||||||
|
format?: ModuleFormat | null | undefined;
|
||||||
|
/**
|
||||||
|
* @deprecated Use `importAttributes` instead
|
||||||
|
*/
|
||||||
|
importAssertions?: ImportAttributes | undefined;
|
||||||
|
/**
|
||||||
|
* The import attributes to use when caching the module (optional; if excluded the input will be used)
|
||||||
|
*/
|
||||||
|
importAttributes?: ImportAttributes | undefined;
|
||||||
|
/**
|
||||||
|
* A signal that this hook intends to terminate the chain of `resolve` hooks.
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
shortCircuit?: boolean | undefined;
|
||||||
|
/**
|
||||||
|
* The absolute URL to which this input resolves
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The `resolve` hook chain is responsible for telling Node.js where to find and
|
||||||
|
* how to cache a given `import` statement or expression, or `require` call. It can
|
||||||
|
* optionally return a format (such as `'module'`) as a hint to the `load` hook. If
|
||||||
|
* a format is specified, the `load` hook is ultimately responsible for providing
|
||||||
|
* the final `format` value (and it is free to ignore the hint provided by
|
||||||
|
* `resolve`); if `resolve` provides a `format`, a custom `load` hook is required
|
||||||
|
* even if only to pass the value to the Node.js default `load` hook.
|
||||||
|
*/
|
||||||
|
type ResolveHook = (
|
||||||
|
specifier: string,
|
||||||
|
context: ResolveHookContext,
|
||||||
|
nextResolve: (
|
||||||
|
specifier: string,
|
||||||
|
context?: Partial<ResolveHookContext>,
|
||||||
|
) => ResolveFnOutput | Promise<ResolveFnOutput>,
|
||||||
|
) => ResolveFnOutput | Promise<ResolveFnOutput>;
|
||||||
|
interface LoadHookContext {
|
||||||
|
/**
|
||||||
|
* Export conditions of the relevant `package.json`
|
||||||
|
*/
|
||||||
|
conditions: string[];
|
||||||
|
/**
|
||||||
|
* The format optionally supplied by the `resolve` hook chain
|
||||||
|
*/
|
||||||
|
format: ModuleFormat | null | undefined;
|
||||||
|
/**
|
||||||
|
* @deprecated Use `importAttributes` instead
|
||||||
|
*/
|
||||||
|
importAssertions: ImportAttributes;
|
||||||
|
/**
|
||||||
|
* An object whose key-value pairs represent the assertions for the module to import
|
||||||
|
*/
|
||||||
|
importAttributes: ImportAttributes;
|
||||||
|
}
|
||||||
|
interface LoadFnOutput {
|
||||||
|
format: string | null | undefined;
|
||||||
|
/**
|
||||||
|
* A signal that this hook intends to terminate the chain of `resolve` hooks.
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
shortCircuit?: boolean | undefined;
|
||||||
|
/**
|
||||||
|
* The source for Node.js to evaluate
|
||||||
|
*/
|
||||||
|
source?: ModuleSource | undefined;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The `load` hook provides a way to define a custom method of determining how a
|
||||||
|
* URL should be interpreted, retrieved, and parsed. It is also in charge of
|
||||||
|
* validating the import attributes.
|
||||||
|
*/
|
||||||
|
type LoadHook = (
|
||||||
|
url: string,
|
||||||
|
context: LoadHookContext,
|
||||||
|
nextLoad: (
|
||||||
|
url: string,
|
||||||
|
context?: Partial<LoadHookContext>,
|
||||||
|
) => LoadFnOutput | Promise<LoadFnOutput>,
|
||||||
|
) => LoadFnOutput | Promise<LoadFnOutput>;
|
||||||
|
interface GlobalPreloadContext {
|
||||||
|
port: MessagePort;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Sometimes it might be necessary to run some code inside of the same global
|
||||||
|
* scope that the application runs in. This hook allows the return of a string
|
||||||
|
* that is run as a sloppy-mode script on startup.
|
||||||
|
* @deprecated This hook will be removed in a future version. Use
|
||||||
|
* `initialize` instead. When a hooks module has an `initialize` export,
|
||||||
|
* `globalPreload` will be ignored.
|
||||||
|
*/
|
||||||
|
type GlobalPreloadHook = (context: GlobalPreloadContext) => string;
|
||||||
|
/**
|
||||||
|
* `path` is the resolved path for the file for which a corresponding source map
|
||||||
|
* should be fetched.
|
||||||
|
* @since v13.7.0, v12.17.0
|
||||||
|
* @return Returns `module.SourceMap` if a source map is found, `undefined` otherwise.
|
||||||
|
*/
|
||||||
|
function findSourceMap(path: string): SourceMap | undefined;
|
||||||
|
interface SourceMapConstructorOptions {
|
||||||
|
/**
|
||||||
|
* @since v20.5.0
|
||||||
|
*/
|
||||||
|
lineLengths?: readonly number[] | undefined;
|
||||||
|
}
|
||||||
|
interface SourceMapPayload {
|
||||||
|
file: string;
|
||||||
|
version: number;
|
||||||
|
sources: string[];
|
||||||
|
sourcesContent: string[];
|
||||||
|
names: string[];
|
||||||
|
mappings: string;
|
||||||
|
sourceRoot: string;
|
||||||
|
}
|
||||||
|
interface SourceMapping {
|
||||||
|
generatedLine: number;
|
||||||
|
generatedColumn: number;
|
||||||
|
originalSource: string;
|
||||||
|
originalLine: number;
|
||||||
|
originalColumn: number;
|
||||||
|
}
|
||||||
|
interface SourceOrigin {
|
||||||
|
/**
|
||||||
|
* The name of the range in the source map, if one was provided
|
||||||
|
*/
|
||||||
|
name: string | undefined;
|
||||||
|
/**
|
||||||
|
* The file name of the original source, as reported in the SourceMap
|
||||||
|
*/
|
||||||
|
fileName: string;
|
||||||
|
/**
|
||||||
|
* The 1-indexed lineNumber of the corresponding call site in the original source
|
||||||
|
*/
|
||||||
|
lineNumber: number;
|
||||||
|
/**
|
||||||
|
* The 1-indexed columnNumber of the corresponding call site in the original source
|
||||||
|
*/
|
||||||
|
columnNumber: number;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* @since v13.7.0, v12.17.0
|
||||||
|
*/
|
||||||
|
class SourceMap {
|
||||||
|
constructor(payload: SourceMapPayload, options?: SourceMapConstructorOptions);
|
||||||
|
/**
|
||||||
|
* Getter for the payload used to construct the `SourceMap` instance.
|
||||||
|
*/
|
||||||
|
readonly payload: SourceMapPayload;
|
||||||
|
/**
|
||||||
|
* Given a line offset and column offset in the generated source
|
||||||
|
* file, returns an object representing the SourceMap range in the
|
||||||
|
* original file if found, or an empty object if not.
|
||||||
|
*
|
||||||
|
* The object returned contains the following keys:
|
||||||
|
*
|
||||||
|
* The returned value represents the raw range as it appears in the
|
||||||
|
* SourceMap, based on zero-indexed offsets, _not_ 1-indexed line and
|
||||||
|
* column numbers as they appear in Error messages and CallSite
|
||||||
|
* objects.
|
||||||
|
*
|
||||||
|
* To get the corresponding 1-indexed line and column numbers from a
|
||||||
|
* lineNumber and columnNumber as they are reported by Error stacks
|
||||||
|
* and CallSite objects, use `sourceMap.findOrigin(lineNumber, columnNumber)`
|
||||||
|
* @param lineOffset The zero-indexed line number offset in the generated source
|
||||||
|
* @param columnOffset The zero-indexed column number offset in the generated source
|
||||||
|
*/
|
||||||
|
findEntry(lineOffset: number, columnOffset: number): SourceMapping | {};
|
||||||
|
/**
|
||||||
|
* Given a 1-indexed `lineNumber` and `columnNumber` from a call site in the generated source,
|
||||||
|
* find the corresponding call site location in the original source.
|
||||||
|
*
|
||||||
|
* If the `lineNumber` and `columnNumber` provided are not found in any source map,
|
||||||
|
* then an empty object is returned.
|
||||||
|
* @param lineNumber The 1-indexed line number of the call site in the generated source
|
||||||
|
* @param columnNumber The 1-indexed column number of the call site in the generated source
|
||||||
|
*/
|
||||||
|
findOrigin(lineNumber: number, columnNumber: number): SourceOrigin | {};
|
||||||
|
}
|
||||||
|
function runMain(main?: string): void;
|
||||||
|
function wrap(script: string): string;
|
||||||
|
}
|
||||||
|
global {
|
||||||
|
interface ImportMeta {
|
||||||
|
/**
|
||||||
|
* The directory name of the current module. This is the same as the `path.dirname()` of the `import.meta.filename`.
|
||||||
|
* **Caveat:** only present on `file:` modules.
|
||||||
|
*/
|
||||||
|
dirname: string;
|
||||||
|
/**
|
||||||
|
* The full absolute path and filename of the current module, with symlinks resolved.
|
||||||
|
* This is the same as the `url.fileURLToPath()` of the `import.meta.url`.
|
||||||
|
* **Caveat:** only local modules support this property. Modules not using the `file:` protocol will not provide it.
|
||||||
|
*/
|
||||||
|
filename: string;
|
||||||
|
/**
|
||||||
|
* The absolute `file:` URL of the module.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
/**
|
||||||
|
* Provides a module-relative resolution function scoped to each module, returning
|
||||||
|
* the URL string.
|
||||||
|
*
|
||||||
|
* Second `parent` parameter is only used when the `--experimental-import-meta-resolve`
|
||||||
|
* command flag enabled.
|
||||||
|
*
|
||||||
|
* @since v20.6.0
|
||||||
|
*
|
||||||
|
* @param specifier The module specifier to resolve relative to `parent`.
|
||||||
|
* @param parent The absolute parent module URL to resolve from.
|
||||||
|
* @returns The absolute (`file:`) URL string for the resolved module.
|
||||||
|
*/
|
||||||
|
resolve(specifier: string, parent?: string | URL | undefined): string;
|
||||||
|
}
|
||||||
|
namespace NodeJS {
|
||||||
|
interface Module {
|
||||||
|
/**
|
||||||
|
* The module objects required for the first time by this one.
|
||||||
|
* @since v0.1.16
|
||||||
|
*/
|
||||||
|
children: Module[];
|
||||||
|
/**
|
||||||
|
* The `module.exports` object is created by the `Module` system. Sometimes this is
|
||||||
|
* not acceptable; many want their module to be an instance of some class. To do
|
||||||
|
* this, assign the desired export object to `module.exports`.
|
||||||
|
* @since v0.1.16
|
||||||
|
*/
|
||||||
|
exports: any;
|
||||||
|
/**
|
||||||
|
* The fully resolved filename of the module.
|
||||||
|
* @since v0.1.16
|
||||||
|
*/
|
||||||
|
filename: string;
|
||||||
|
/**
|
||||||
|
* The identifier for the module. Typically this is the fully resolved
|
||||||
|
* filename.
|
||||||
|
* @since v0.1.16
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
/**
|
||||||
|
* `true` if the module is running during the Node.js preload
|
||||||
|
* phase.
|
||||||
|
* @since v15.4.0, v14.17.0
|
||||||
|
*/
|
||||||
|
isPreloading: boolean;
|
||||||
|
/**
|
||||||
|
* Whether or not the module is done loading, or is in the process of
|
||||||
|
* loading.
|
||||||
|
* @since v0.1.16
|
||||||
|
*/
|
||||||
|
loaded: boolean;
|
||||||
|
/**
|
||||||
|
* The module that first required this one, or `null` if the current module is the
|
||||||
|
* entry point of the current process, or `undefined` if the module was loaded by
|
||||||
|
* something that is not a CommonJS module (e.g. REPL or `import`).
|
||||||
|
* @since v0.1.16
|
||||||
|
* @deprecated Please use `require.main` and `module.children` instead.
|
||||||
|
*/
|
||||||
|
parent: Module | null | undefined;
|
||||||
|
/**
|
||||||
|
* The directory name of the module. This is usually the same as the
|
||||||
|
* `path.dirname()` of the `module.id`.
|
||||||
|
* @since v11.14.0
|
||||||
|
*/
|
||||||
|
path: string;
|
||||||
|
/**
|
||||||
|
* The search paths for the module.
|
||||||
|
* @since v0.4.0
|
||||||
|
*/
|
||||||
|
paths: string[];
|
||||||
|
/**
|
||||||
|
* The `module.require()` method provides a way to load a module as if
|
||||||
|
* `require()` was called from the original module.
|
||||||
|
* @since v0.5.1
|
||||||
|
*/
|
||||||
|
require(id: string): any;
|
||||||
|
}
|
||||||
|
interface Require {
|
||||||
|
/**
|
||||||
|
* Used to import modules, `JSON`, and local files.
|
||||||
|
* @since v0.1.13
|
||||||
|
*/
|
||||||
|
(id: string): any;
|
||||||
|
/**
|
||||||
|
* Modules are cached in this object when they are required. By deleting a key
|
||||||
|
* value from this object, the next `require` will reload the module.
|
||||||
|
* This does not apply to
|
||||||
|
* [native addons](https://nodejs.org/docs/latest-v20.x/api/addons.html),
|
||||||
|
* for which reloading will result in an error.
|
||||||
|
* @since v0.3.0
|
||||||
|
*/
|
||||||
|
cache: Dict<Module>;
|
||||||
|
/**
|
||||||
|
* Instruct `require` on how to handle certain file extensions.
|
||||||
|
* @since v0.3.0
|
||||||
|
* @deprecated
|
||||||
|
*/
|
||||||
|
extensions: RequireExtensions;
|
||||||
|
/**
|
||||||
|
* The `Module` object representing the entry script loaded when the Node.js
|
||||||
|
* process launched, or `undefined` if the entry point of the program is not a
|
||||||
|
* CommonJS module.
|
||||||
|
* @since v0.1.17
|
||||||
|
*/
|
||||||
|
main: Module | undefined;
|
||||||
|
/**
|
||||||
|
* @since v0.3.0
|
||||||
|
*/
|
||||||
|
resolve: RequireResolve;
|
||||||
|
}
|
||||||
|
/** @deprecated */
|
||||||
|
interface RequireExtensions extends Dict<(module: Module, filename: string) => any> {
|
||||||
|
".js": (module: Module, filename: string) => any;
|
||||||
|
".json": (module: Module, filename: string) => any;
|
||||||
|
".node": (module: Module, filename: string) => any;
|
||||||
|
}
|
||||||
|
interface RequireResolveOptions {
|
||||||
|
/**
|
||||||
|
* Paths to resolve module location from. If present, these
|
||||||
|
* paths are used instead of the default resolution paths, with the exception
|
||||||
|
* of
|
||||||
|
* [GLOBAL\_FOLDERS](https://nodejs.org/docs/latest-v20.x/api/modules.html#loading-from-the-global-folders)
|
||||||
|
* like `$HOME/.node_modules`, which are
|
||||||
|
* always included. Each of these paths is used as a starting point for
|
||||||
|
* the module resolution algorithm, meaning that the `node_modules` hierarchy
|
||||||
|
* is checked from this location.
|
||||||
|
* @since v8.9.0
|
||||||
|
*/
|
||||||
|
paths?: string[] | undefined;
|
||||||
|
}
|
||||||
|
interface RequireResolve {
|
||||||
|
/**
|
||||||
|
* Use the internal `require()` machinery to look up the location of a module,
|
||||||
|
* but rather than loading the module, just return the resolved filename.
|
||||||
|
*
|
||||||
|
* If the module can not be found, a `MODULE_NOT_FOUND` error is thrown.
|
||||||
|
* @since v0.3.0
|
||||||
|
* @param request The module path to resolve.
|
||||||
|
*/
|
||||||
|
(id: string, options?: RequireResolveOptions): string;
|
||||||
|
/**
|
||||||
|
* Returns an array containing the paths searched during resolution of `request` or
|
||||||
|
* `null` if the `request` string references a core module, for example `http` or
|
||||||
|
* `fs`.
|
||||||
|
* @since v8.9.0
|
||||||
|
* @param request The module path whose lookup paths are being retrieved.
|
||||||
|
*/
|
||||||
|
paths(request: string): string[] | null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The directory name of the current module. This is the same as the
|
||||||
|
* `path.dirname()` of the `__filename`.
|
||||||
|
* @since v0.1.27
|
||||||
|
*/
|
||||||
|
var __dirname: string;
|
||||||
|
/**
|
||||||
|
* The file name of the current module. This is the current module file's absolute
|
||||||
|
* path with symlinks resolved.
|
||||||
|
*
|
||||||
|
* For a main program this is not necessarily the same as the file name used in the
|
||||||
|
* command line.
|
||||||
|
* @since v0.0.1
|
||||||
|
*/
|
||||||
|
var __filename: string;
|
||||||
|
/**
|
||||||
|
* The `exports` variable is available within a module's file-level scope, and is
|
||||||
|
* assigned the value of `module.exports` before the module is evaluated.
|
||||||
|
* @since v0.1.16
|
||||||
|
*/
|
||||||
|
var exports: NodeJS.Module["exports"];
|
||||||
|
/**
|
||||||
|
* A reference to the current module.
|
||||||
|
* @since v0.1.16
|
||||||
|
*/
|
||||||
|
var module: NodeJS.Module;
|
||||||
|
/**
|
||||||
|
* @since v0.1.13
|
||||||
|
*/
|
||||||
|
var require: NodeJS.Require;
|
||||||
|
// Global-scope aliases for backwards compatibility with @types/node <13.0.x
|
||||||
|
/** @deprecated Use `NodeJS.Module` instead. */
|
||||||
|
interface NodeModule extends NodeJS.Module {}
|
||||||
|
/** @deprecated Use `NodeJS.Require` instead. */
|
||||||
|
interface NodeRequire extends NodeJS.Require {}
|
||||||
|
/** @deprecated Use `NodeJS.RequireResolve` instead. */
|
||||||
|
interface RequireResolve extends NodeJS.RequireResolve {}
|
||||||
|
}
|
||||||
|
export = Module;
|
||||||
|
}
|
||||||
|
declare module "node:module" {
|
||||||
|
import module = require("module");
|
||||||
|
export = module;
|
||||||
|
}
|
||||||
+1012
File diff suppressed because it is too large
Load Diff
+506
@@ -0,0 +1,506 @@
|
|||||||
|
/**
|
||||||
|
* The `node:os` module provides operating system-related utility methods and
|
||||||
|
* properties. It can be accessed using:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import os from 'node:os';
|
||||||
|
* ```
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/os.js)
|
||||||
|
*/
|
||||||
|
declare module "os" {
|
||||||
|
import { NonSharedBuffer } from "buffer";
|
||||||
|
interface CpuInfo {
|
||||||
|
model: string;
|
||||||
|
speed: number;
|
||||||
|
times: {
|
||||||
|
/** The number of milliseconds the CPU has spent in user mode. */
|
||||||
|
user: number;
|
||||||
|
/** The number of milliseconds the CPU has spent in nice mode. */
|
||||||
|
nice: number;
|
||||||
|
/** The number of milliseconds the CPU has spent in sys mode. */
|
||||||
|
sys: number;
|
||||||
|
/** The number of milliseconds the CPU has spent in idle mode. */
|
||||||
|
idle: number;
|
||||||
|
/** The number of milliseconds the CPU has spent in irq mode. */
|
||||||
|
irq: number;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
interface NetworkInterfaceBase {
|
||||||
|
address: string;
|
||||||
|
netmask: string;
|
||||||
|
mac: string;
|
||||||
|
internal: boolean;
|
||||||
|
cidr: string | null;
|
||||||
|
scopeid?: number;
|
||||||
|
}
|
||||||
|
interface NetworkInterfaceInfoIPv4 extends NetworkInterfaceBase {
|
||||||
|
family: "IPv4";
|
||||||
|
}
|
||||||
|
interface NetworkInterfaceInfoIPv6 extends NetworkInterfaceBase {
|
||||||
|
family: "IPv6";
|
||||||
|
scopeid: number;
|
||||||
|
}
|
||||||
|
interface UserInfo<T> {
|
||||||
|
username: T;
|
||||||
|
uid: number;
|
||||||
|
gid: number;
|
||||||
|
shell: T | null;
|
||||||
|
homedir: T;
|
||||||
|
}
|
||||||
|
type NetworkInterfaceInfo = NetworkInterfaceInfoIPv4 | NetworkInterfaceInfoIPv6;
|
||||||
|
/**
|
||||||
|
* Returns the host name of the operating system as a string.
|
||||||
|
* @since v0.3.3
|
||||||
|
*/
|
||||||
|
function hostname(): string;
|
||||||
|
/**
|
||||||
|
* Returns an array containing the 1, 5, and 15 minute load averages.
|
||||||
|
*
|
||||||
|
* The load average is a measure of system activity calculated by the operating
|
||||||
|
* system and expressed as a fractional number.
|
||||||
|
*
|
||||||
|
* The load average is a Unix-specific concept. On Windows, the return value is
|
||||||
|
* always `[0, 0, 0]`.
|
||||||
|
* @since v0.3.3
|
||||||
|
*/
|
||||||
|
function loadavg(): number[];
|
||||||
|
/**
|
||||||
|
* Returns the system uptime in number of seconds.
|
||||||
|
* @since v0.3.3
|
||||||
|
*/
|
||||||
|
function uptime(): number;
|
||||||
|
/**
|
||||||
|
* Returns the amount of free system memory in bytes as an integer.
|
||||||
|
* @since v0.3.3
|
||||||
|
*/
|
||||||
|
function freemem(): number;
|
||||||
|
/**
|
||||||
|
* Returns the total amount of system memory in bytes as an integer.
|
||||||
|
* @since v0.3.3
|
||||||
|
*/
|
||||||
|
function totalmem(): number;
|
||||||
|
/**
|
||||||
|
* Returns an array of objects containing information about each logical CPU core.
|
||||||
|
* The array will be empty if no CPU information is available, such as if the `/proc` file system is unavailable.
|
||||||
|
*
|
||||||
|
* The properties included on each object include:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* [
|
||||||
|
* {
|
||||||
|
* model: 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz',
|
||||||
|
* speed: 2926,
|
||||||
|
* times: {
|
||||||
|
* user: 252020,
|
||||||
|
* nice: 0,
|
||||||
|
* sys: 30340,
|
||||||
|
* idle: 1070356870,
|
||||||
|
* irq: 0,
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* {
|
||||||
|
* model: 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz',
|
||||||
|
* speed: 2926,
|
||||||
|
* times: {
|
||||||
|
* user: 306960,
|
||||||
|
* nice: 0,
|
||||||
|
* sys: 26980,
|
||||||
|
* idle: 1071569080,
|
||||||
|
* irq: 0,
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* {
|
||||||
|
* model: 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz',
|
||||||
|
* speed: 2926,
|
||||||
|
* times: {
|
||||||
|
* user: 248450,
|
||||||
|
* nice: 0,
|
||||||
|
* sys: 21750,
|
||||||
|
* idle: 1070919370,
|
||||||
|
* irq: 0,
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* {
|
||||||
|
* model: 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz',
|
||||||
|
* speed: 2926,
|
||||||
|
* times: {
|
||||||
|
* user: 256880,
|
||||||
|
* nice: 0,
|
||||||
|
* sys: 19430,
|
||||||
|
* idle: 1070905480,
|
||||||
|
* irq: 20,
|
||||||
|
* },
|
||||||
|
* },
|
||||||
|
* ]
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* `nice` values are POSIX-only. On Windows, the `nice` values of all processors
|
||||||
|
* are always 0.
|
||||||
|
*
|
||||||
|
* `os.cpus().length` should not be used to calculate the amount of parallelism
|
||||||
|
* available to an application. Use {@link availableParallelism} for this purpose.
|
||||||
|
* @since v0.3.3
|
||||||
|
*/
|
||||||
|
function cpus(): CpuInfo[];
|
||||||
|
/**
|
||||||
|
* Returns an estimate of the default amount of parallelism a program should use.
|
||||||
|
* Always returns a value greater than zero.
|
||||||
|
*
|
||||||
|
* This function is a small wrapper about libuv's [`uv_available_parallelism()`](https://docs.libuv.org/en/v1.x/misc.html#c.uv_available_parallelism).
|
||||||
|
* @since v19.4.0, v18.14.0
|
||||||
|
*/
|
||||||
|
function availableParallelism(): number;
|
||||||
|
/**
|
||||||
|
* Returns the operating system name as returned by [`uname(3)`](https://linux.die.net/man/3/uname). For example, it
|
||||||
|
* returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows.
|
||||||
|
*
|
||||||
|
* See [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for additional information
|
||||||
|
* about the output of running [`uname(3)`](https://linux.die.net/man/3/uname) on various operating systems.
|
||||||
|
* @since v0.3.3
|
||||||
|
*/
|
||||||
|
function type(): string;
|
||||||
|
/**
|
||||||
|
* Returns the operating system as a string.
|
||||||
|
*
|
||||||
|
* On POSIX systems, the operating system release is determined by calling [`uname(3)`](https://linux.die.net/man/3/uname). On Windows, `GetVersionExW()` is used. See
|
||||||
|
* [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for more information.
|
||||||
|
* @since v0.3.3
|
||||||
|
*/
|
||||||
|
function release(): string;
|
||||||
|
/**
|
||||||
|
* Returns an object containing network interfaces that have been assigned a
|
||||||
|
* network address.
|
||||||
|
*
|
||||||
|
* Each key on the returned object identifies a network interface. The associated
|
||||||
|
* value is an array of objects that each describe an assigned network address.
|
||||||
|
*
|
||||||
|
* The properties available on the assigned network address object include:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* {
|
||||||
|
* lo: [
|
||||||
|
* {
|
||||||
|
* address: '127.0.0.1',
|
||||||
|
* netmask: '255.0.0.0',
|
||||||
|
* family: 'IPv4',
|
||||||
|
* mac: '00:00:00:00:00:00',
|
||||||
|
* internal: true,
|
||||||
|
* cidr: '127.0.0.1/8'
|
||||||
|
* },
|
||||||
|
* {
|
||||||
|
* address: '::1',
|
||||||
|
* netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
|
||||||
|
* family: 'IPv6',
|
||||||
|
* mac: '00:00:00:00:00:00',
|
||||||
|
* scopeid: 0,
|
||||||
|
* internal: true,
|
||||||
|
* cidr: '::1/128'
|
||||||
|
* }
|
||||||
|
* ],
|
||||||
|
* eth0: [
|
||||||
|
* {
|
||||||
|
* address: '192.168.1.108',
|
||||||
|
* netmask: '255.255.255.0',
|
||||||
|
* family: 'IPv4',
|
||||||
|
* mac: '01:02:03:0a:0b:0c',
|
||||||
|
* internal: false,
|
||||||
|
* cidr: '192.168.1.108/24'
|
||||||
|
* },
|
||||||
|
* {
|
||||||
|
* address: 'fe80::a00:27ff:fe4e:66a1',
|
||||||
|
* netmask: 'ffff:ffff:ffff:ffff::',
|
||||||
|
* family: 'IPv6',
|
||||||
|
* mac: '01:02:03:0a:0b:0c',
|
||||||
|
* scopeid: 1,
|
||||||
|
* internal: false,
|
||||||
|
* cidr: 'fe80::a00:27ff:fe4e:66a1/64'
|
||||||
|
* }
|
||||||
|
* ]
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @since v0.6.0
|
||||||
|
*/
|
||||||
|
function networkInterfaces(): NodeJS.Dict<NetworkInterfaceInfo[]>;
|
||||||
|
/**
|
||||||
|
* Returns the string path of the current user's home directory.
|
||||||
|
*
|
||||||
|
* On POSIX, it uses the `$HOME` environment variable if defined. Otherwise it
|
||||||
|
* uses the [effective UID](https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID) to look up the user's home directory.
|
||||||
|
*
|
||||||
|
* On Windows, it uses the `USERPROFILE` environment variable if defined.
|
||||||
|
* Otherwise it uses the path to the profile directory of the current user.
|
||||||
|
* @since v2.3.0
|
||||||
|
*/
|
||||||
|
function homedir(): string;
|
||||||
|
interface UserInfoOptions {
|
||||||
|
encoding?: BufferEncoding | "buffer" | undefined;
|
||||||
|
}
|
||||||
|
interface UserInfoOptionsWithBufferEncoding extends UserInfoOptions {
|
||||||
|
encoding: "buffer";
|
||||||
|
}
|
||||||
|
interface UserInfoOptionsWithStringEncoding extends UserInfoOptions {
|
||||||
|
encoding?: BufferEncoding | undefined;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Returns information about the currently effective user. On POSIX platforms,
|
||||||
|
* this is typically a subset of the password file. The returned object includes
|
||||||
|
* the `username`, `uid`, `gid`, `shell`, and `homedir`. On Windows, the `uid` and `gid` fields are `-1`, and `shell` is `null`.
|
||||||
|
*
|
||||||
|
* The value of `homedir` returned by `os.userInfo()` is provided by the operating
|
||||||
|
* system. This differs from the result of `os.homedir()`, which queries
|
||||||
|
* environment variables for the home directory before falling back to the
|
||||||
|
* operating system response.
|
||||||
|
*
|
||||||
|
* Throws a [`SystemError`](https://nodejs.org/docs/latest-v20.x/api/errors.html#class-systemerror) if a user has no `username` or `homedir`.
|
||||||
|
* @since v6.0.0
|
||||||
|
*/
|
||||||
|
function userInfo(options?: UserInfoOptionsWithStringEncoding): UserInfo<string>;
|
||||||
|
function userInfo(options: UserInfoOptionsWithBufferEncoding): UserInfo<NonSharedBuffer>;
|
||||||
|
function userInfo(options: UserInfoOptions): UserInfo<string | NonSharedBuffer>;
|
||||||
|
type SignalConstants = {
|
||||||
|
[key in NodeJS.Signals]: number;
|
||||||
|
};
|
||||||
|
namespace constants {
|
||||||
|
const UV_UDP_REUSEADDR: number;
|
||||||
|
namespace signals {}
|
||||||
|
const signals: SignalConstants;
|
||||||
|
namespace errno {
|
||||||
|
const E2BIG: number;
|
||||||
|
const EACCES: number;
|
||||||
|
const EADDRINUSE: number;
|
||||||
|
const EADDRNOTAVAIL: number;
|
||||||
|
const EAFNOSUPPORT: number;
|
||||||
|
const EAGAIN: number;
|
||||||
|
const EALREADY: number;
|
||||||
|
const EBADF: number;
|
||||||
|
const EBADMSG: number;
|
||||||
|
const EBUSY: number;
|
||||||
|
const ECANCELED: number;
|
||||||
|
const ECHILD: number;
|
||||||
|
const ECONNABORTED: number;
|
||||||
|
const ECONNREFUSED: number;
|
||||||
|
const ECONNRESET: number;
|
||||||
|
const EDEADLK: number;
|
||||||
|
const EDESTADDRREQ: number;
|
||||||
|
const EDOM: number;
|
||||||
|
const EDQUOT: number;
|
||||||
|
const EEXIST: number;
|
||||||
|
const EFAULT: number;
|
||||||
|
const EFBIG: number;
|
||||||
|
const EHOSTUNREACH: number;
|
||||||
|
const EIDRM: number;
|
||||||
|
const EILSEQ: number;
|
||||||
|
const EINPROGRESS: number;
|
||||||
|
const EINTR: number;
|
||||||
|
const EINVAL: number;
|
||||||
|
const EIO: number;
|
||||||
|
const EISCONN: number;
|
||||||
|
const EISDIR: number;
|
||||||
|
const ELOOP: number;
|
||||||
|
const EMFILE: number;
|
||||||
|
const EMLINK: number;
|
||||||
|
const EMSGSIZE: number;
|
||||||
|
const EMULTIHOP: number;
|
||||||
|
const ENAMETOOLONG: number;
|
||||||
|
const ENETDOWN: number;
|
||||||
|
const ENETRESET: number;
|
||||||
|
const ENETUNREACH: number;
|
||||||
|
const ENFILE: number;
|
||||||
|
const ENOBUFS: number;
|
||||||
|
const ENODATA: number;
|
||||||
|
const ENODEV: number;
|
||||||
|
const ENOENT: number;
|
||||||
|
const ENOEXEC: number;
|
||||||
|
const ENOLCK: number;
|
||||||
|
const ENOLINK: number;
|
||||||
|
const ENOMEM: number;
|
||||||
|
const ENOMSG: number;
|
||||||
|
const ENOPROTOOPT: number;
|
||||||
|
const ENOSPC: number;
|
||||||
|
const ENOSR: number;
|
||||||
|
const ENOSTR: number;
|
||||||
|
const ENOSYS: number;
|
||||||
|
const ENOTCONN: number;
|
||||||
|
const ENOTDIR: number;
|
||||||
|
const ENOTEMPTY: number;
|
||||||
|
const ENOTSOCK: number;
|
||||||
|
const ENOTSUP: number;
|
||||||
|
const ENOTTY: number;
|
||||||
|
const ENXIO: number;
|
||||||
|
const EOPNOTSUPP: number;
|
||||||
|
const EOVERFLOW: number;
|
||||||
|
const EPERM: number;
|
||||||
|
const EPIPE: number;
|
||||||
|
const EPROTO: number;
|
||||||
|
const EPROTONOSUPPORT: number;
|
||||||
|
const EPROTOTYPE: number;
|
||||||
|
const ERANGE: number;
|
||||||
|
const EROFS: number;
|
||||||
|
const ESPIPE: number;
|
||||||
|
const ESRCH: number;
|
||||||
|
const ESTALE: number;
|
||||||
|
const ETIME: number;
|
||||||
|
const ETIMEDOUT: number;
|
||||||
|
const ETXTBSY: number;
|
||||||
|
const EWOULDBLOCK: number;
|
||||||
|
const EXDEV: number;
|
||||||
|
const WSAEINTR: number;
|
||||||
|
const WSAEBADF: number;
|
||||||
|
const WSAEACCES: number;
|
||||||
|
const WSAEFAULT: number;
|
||||||
|
const WSAEINVAL: number;
|
||||||
|
const WSAEMFILE: number;
|
||||||
|
const WSAEWOULDBLOCK: number;
|
||||||
|
const WSAEINPROGRESS: number;
|
||||||
|
const WSAEALREADY: number;
|
||||||
|
const WSAENOTSOCK: number;
|
||||||
|
const WSAEDESTADDRREQ: number;
|
||||||
|
const WSAEMSGSIZE: number;
|
||||||
|
const WSAEPROTOTYPE: number;
|
||||||
|
const WSAENOPROTOOPT: number;
|
||||||
|
const WSAEPROTONOSUPPORT: number;
|
||||||
|
const WSAESOCKTNOSUPPORT: number;
|
||||||
|
const WSAEOPNOTSUPP: number;
|
||||||
|
const WSAEPFNOSUPPORT: number;
|
||||||
|
const WSAEAFNOSUPPORT: number;
|
||||||
|
const WSAEADDRINUSE: number;
|
||||||
|
const WSAEADDRNOTAVAIL: number;
|
||||||
|
const WSAENETDOWN: number;
|
||||||
|
const WSAENETUNREACH: number;
|
||||||
|
const WSAENETRESET: number;
|
||||||
|
const WSAECONNABORTED: number;
|
||||||
|
const WSAECONNRESET: number;
|
||||||
|
const WSAENOBUFS: number;
|
||||||
|
const WSAEISCONN: number;
|
||||||
|
const WSAENOTCONN: number;
|
||||||
|
const WSAESHUTDOWN: number;
|
||||||
|
const WSAETOOMANYREFS: number;
|
||||||
|
const WSAETIMEDOUT: number;
|
||||||
|
const WSAECONNREFUSED: number;
|
||||||
|
const WSAELOOP: number;
|
||||||
|
const WSAENAMETOOLONG: number;
|
||||||
|
const WSAEHOSTDOWN: number;
|
||||||
|
const WSAEHOSTUNREACH: number;
|
||||||
|
const WSAENOTEMPTY: number;
|
||||||
|
const WSAEPROCLIM: number;
|
||||||
|
const WSAEUSERS: number;
|
||||||
|
const WSAEDQUOT: number;
|
||||||
|
const WSAESTALE: number;
|
||||||
|
const WSAEREMOTE: number;
|
||||||
|
const WSASYSNOTREADY: number;
|
||||||
|
const WSAVERNOTSUPPORTED: number;
|
||||||
|
const WSANOTINITIALISED: number;
|
||||||
|
const WSAEDISCON: number;
|
||||||
|
const WSAENOMORE: number;
|
||||||
|
const WSAECANCELLED: number;
|
||||||
|
const WSAEINVALIDPROCTABLE: number;
|
||||||
|
const WSAEINVALIDPROVIDER: number;
|
||||||
|
const WSAEPROVIDERFAILEDINIT: number;
|
||||||
|
const WSASYSCALLFAILURE: number;
|
||||||
|
const WSASERVICE_NOT_FOUND: number;
|
||||||
|
const WSATYPE_NOT_FOUND: number;
|
||||||
|
const WSA_E_NO_MORE: number;
|
||||||
|
const WSA_E_CANCELLED: number;
|
||||||
|
const WSAEREFUSED: number;
|
||||||
|
}
|
||||||
|
namespace dlopen {
|
||||||
|
const RTLD_LAZY: number;
|
||||||
|
const RTLD_NOW: number;
|
||||||
|
const RTLD_GLOBAL: number;
|
||||||
|
const RTLD_LOCAL: number;
|
||||||
|
const RTLD_DEEPBIND: number;
|
||||||
|
}
|
||||||
|
namespace priority {
|
||||||
|
const PRIORITY_LOW: number;
|
||||||
|
const PRIORITY_BELOW_NORMAL: number;
|
||||||
|
const PRIORITY_NORMAL: number;
|
||||||
|
const PRIORITY_ABOVE_NORMAL: number;
|
||||||
|
const PRIORITY_HIGH: number;
|
||||||
|
const PRIORITY_HIGHEST: number;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const devNull: string;
|
||||||
|
/**
|
||||||
|
* The operating system-specific end-of-line marker.
|
||||||
|
* * `\n` on POSIX
|
||||||
|
* * `\r\n` on Windows
|
||||||
|
*/
|
||||||
|
const EOL: string;
|
||||||
|
/**
|
||||||
|
* Returns the operating system CPU architecture for which the Node.js binary was
|
||||||
|
* compiled. Possible values are `'arm'`, `'arm64'`, `'ia32'`, `'loong64'`, `'mips'`, `'mipsel'`, `'ppc'`, `'ppc64'`, `'riscv64'`, `'s390'`, `'s390x'`,
|
||||||
|
* and `'x64'`.
|
||||||
|
*
|
||||||
|
* The return value is equivalent to [process.arch](https://nodejs.org/docs/latest-v20.x/api/process.html#processarch).
|
||||||
|
* @since v0.5.0
|
||||||
|
*/
|
||||||
|
function arch(): string;
|
||||||
|
/**
|
||||||
|
* Returns a string identifying the kernel version.
|
||||||
|
*
|
||||||
|
* On POSIX systems, the operating system release is determined by calling [`uname(3)`](https://linux.die.net/man/3/uname). On Windows, `RtlGetVersion()` is used, and if it is not
|
||||||
|
* available, `GetVersionExW()` will be used. See [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for more information.
|
||||||
|
* @since v13.11.0, v12.17.0
|
||||||
|
*/
|
||||||
|
function version(): string;
|
||||||
|
/**
|
||||||
|
* Returns a string identifying the operating system platform for which
|
||||||
|
* the Node.js binary was compiled. The value is set at compile time.
|
||||||
|
* Possible values are `'aix'`, `'darwin'`, `'freebsd'`, `'linux'`, `'openbsd'`, `'sunos'`, and `'win32'`.
|
||||||
|
*
|
||||||
|
* The return value is equivalent to `process.platform`.
|
||||||
|
*
|
||||||
|
* The value `'android'` may also be returned if Node.js is built on the Android
|
||||||
|
* operating system. [Android support is experimental](https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os).
|
||||||
|
* @since v0.5.0
|
||||||
|
*/
|
||||||
|
function platform(): NodeJS.Platform;
|
||||||
|
/**
|
||||||
|
* Returns the machine type as a string, such as `arm`, `arm64`, `aarch64`, `mips`, `mips64`, `ppc64`, `ppc64le`, `s390`, `s390x`, `i386`, `i686`, `x86_64`.
|
||||||
|
*
|
||||||
|
* On POSIX systems, the machine type is determined by calling [`uname(3)`](https://linux.die.net/man/3/uname). On Windows, `RtlGetVersion()` is used, and if it is not
|
||||||
|
* available, `GetVersionExW()` will be used. See [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for more information.
|
||||||
|
* @since v18.9.0, v16.18.0
|
||||||
|
*/
|
||||||
|
function machine(): string;
|
||||||
|
/**
|
||||||
|
* Returns the operating system's default directory for temporary files as a
|
||||||
|
* string.
|
||||||
|
* @since v0.9.9
|
||||||
|
*/
|
||||||
|
function tmpdir(): string;
|
||||||
|
/**
|
||||||
|
* Returns a string identifying the endianness of the CPU for which the Node.js
|
||||||
|
* binary was compiled.
|
||||||
|
*
|
||||||
|
* Possible values are `'BE'` for big endian and `'LE'` for little endian.
|
||||||
|
* @since v0.9.4
|
||||||
|
*/
|
||||||
|
function endianness(): "BE" | "LE";
|
||||||
|
/**
|
||||||
|
* Returns the scheduling priority for the process specified by `pid`. If `pid` is
|
||||||
|
* not provided or is `0`, the priority of the current process is returned.
|
||||||
|
* @since v10.10.0
|
||||||
|
* @param [pid=0] The process ID to retrieve scheduling priority for.
|
||||||
|
*/
|
||||||
|
function getPriority(pid?: number): number;
|
||||||
|
/**
|
||||||
|
* Attempts to set the scheduling priority for the process specified by `pid`. If `pid` is not provided or is `0`, the process ID of the current process is used.
|
||||||
|
*
|
||||||
|
* The `priority` input must be an integer between `-20` (high priority) and `19` (low priority). Due to differences between Unix priority levels and Windows
|
||||||
|
* priority classes, `priority` is mapped to one of six priority constants in `os.constants.priority`. When retrieving a process priority level, this range
|
||||||
|
* mapping may cause the return value to be slightly different on Windows. To avoid
|
||||||
|
* confusion, set `priority` to one of the priority constants.
|
||||||
|
*
|
||||||
|
* On Windows, setting priority to `PRIORITY_HIGHEST` requires elevated user
|
||||||
|
* privileges. Otherwise the set priority will be silently reduced to `PRIORITY_HIGH`.
|
||||||
|
* @since v10.10.0
|
||||||
|
* @param [pid=0] The process ID to set scheduling priority for.
|
||||||
|
* @param priority The scheduling priority to assign to the process.
|
||||||
|
*/
|
||||||
|
function setPriority(priority: number): void;
|
||||||
|
function setPriority(pid: number, priority: number): void;
|
||||||
|
}
|
||||||
|
declare module "node:os" {
|
||||||
|
export * from "os";
|
||||||
|
}
|
||||||
+140
@@ -0,0 +1,140 @@
|
|||||||
|
{
|
||||||
|
"name": "@types/node",
|
||||||
|
"version": "20.19.37",
|
||||||
|
"description": "TypeScript definitions for node",
|
||||||
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
|
||||||
|
"license": "MIT",
|
||||||
|
"contributors": [
|
||||||
|
{
|
||||||
|
"name": "Microsoft TypeScript",
|
||||||
|
"githubUsername": "Microsoft",
|
||||||
|
"url": "https://github.com/Microsoft"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Alberto Schiabel",
|
||||||
|
"githubUsername": "jkomyno",
|
||||||
|
"url": "https://github.com/jkomyno"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Andrew Makarov",
|
||||||
|
"githubUsername": "r3nya",
|
||||||
|
"url": "https://github.com/r3nya"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Benjamin Toueg",
|
||||||
|
"githubUsername": "btoueg",
|
||||||
|
"url": "https://github.com/btoueg"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "David Junger",
|
||||||
|
"githubUsername": "touffy",
|
||||||
|
"url": "https://github.com/touffy"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Mohsen Azimi",
|
||||||
|
"githubUsername": "mohsen1",
|
||||||
|
"url": "https://github.com/mohsen1"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Nikita Galkin",
|
||||||
|
"githubUsername": "galkin",
|
||||||
|
"url": "https://github.com/galkin"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Sebastian Silbermann",
|
||||||
|
"githubUsername": "eps1lon",
|
||||||
|
"url": "https://github.com/eps1lon"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Wilco Bakker",
|
||||||
|
"githubUsername": "WilcoBakker",
|
||||||
|
"url": "https://github.com/WilcoBakker"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Marcin Kopacz",
|
||||||
|
"githubUsername": "chyzwar",
|
||||||
|
"url": "https://github.com/chyzwar"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Trivikram Kamat",
|
||||||
|
"githubUsername": "trivikr",
|
||||||
|
"url": "https://github.com/trivikr"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Junxiao Shi",
|
||||||
|
"githubUsername": "yoursunny",
|
||||||
|
"url": "https://github.com/yoursunny"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Ilia Baryshnikov",
|
||||||
|
"githubUsername": "qwelias",
|
||||||
|
"url": "https://github.com/qwelias"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "ExE Boss",
|
||||||
|
"githubUsername": "ExE-Boss",
|
||||||
|
"url": "https://github.com/ExE-Boss"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Piotr Błażejewicz",
|
||||||
|
"githubUsername": "peterblazejewicz",
|
||||||
|
"url": "https://github.com/peterblazejewicz"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Anna Henningsen",
|
||||||
|
"githubUsername": "addaleax",
|
||||||
|
"url": "https://github.com/addaleax"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Victor Perin",
|
||||||
|
"githubUsername": "victorperin",
|
||||||
|
"url": "https://github.com/victorperin"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "NodeJS Contributors",
|
||||||
|
"githubUsername": "NodeJS",
|
||||||
|
"url": "https://github.com/NodeJS"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Linus Unnebäck",
|
||||||
|
"githubUsername": "LinusU",
|
||||||
|
"url": "https://github.com/LinusU"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "wafuwafu13",
|
||||||
|
"githubUsername": "wafuwafu13",
|
||||||
|
"url": "https://github.com/wafuwafu13"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Matteo Collina",
|
||||||
|
"githubUsername": "mcollina",
|
||||||
|
"url": "https://github.com/mcollina"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Dmitry Semigradsky",
|
||||||
|
"githubUsername": "Semigradsky",
|
||||||
|
"url": "https://github.com/Semigradsky"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"main": "",
|
||||||
|
"types": "index.d.ts",
|
||||||
|
"typesVersions": {
|
||||||
|
"<=5.6": {
|
||||||
|
"*": [
|
||||||
|
"ts5.6/*"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
|
||||||
|
"directory": "types/node"
|
||||||
|
},
|
||||||
|
"scripts": {},
|
||||||
|
"dependencies": {
|
||||||
|
"undici-types": "~6.21.0"
|
||||||
|
},
|
||||||
|
"peerDependencies": {},
|
||||||
|
"typesPublisherContentHash": "232436132f92bb9d0f77b98004c7a2477747cc93116b454e2d1ffaf892e9bdd2",
|
||||||
|
"typeScriptVersion": "5.2"
|
||||||
|
}
|
||||||
+200
@@ -0,0 +1,200 @@
|
|||||||
|
declare module "path/posix" {
|
||||||
|
import path = require("path");
|
||||||
|
export = path;
|
||||||
|
}
|
||||||
|
declare module "path/win32" {
|
||||||
|
import path = require("path");
|
||||||
|
export = path;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The `node:path` module provides utilities for working with file and directory
|
||||||
|
* paths. It can be accessed using:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import path from 'node:path';
|
||||||
|
* ```
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/path.js)
|
||||||
|
*/
|
||||||
|
declare module "path" {
|
||||||
|
namespace path {
|
||||||
|
/**
|
||||||
|
* A parsed path object generated by path.parse() or consumed by path.format().
|
||||||
|
*/
|
||||||
|
interface ParsedPath {
|
||||||
|
/**
|
||||||
|
* The root of the path such as '/' or 'c:\'
|
||||||
|
*/
|
||||||
|
root: string;
|
||||||
|
/**
|
||||||
|
* The full directory path such as '/home/user/dir' or 'c:\path\dir'
|
||||||
|
*/
|
||||||
|
dir: string;
|
||||||
|
/**
|
||||||
|
* The file name including extension (if any) such as 'index.html'
|
||||||
|
*/
|
||||||
|
base: string;
|
||||||
|
/**
|
||||||
|
* The file extension (if any) such as '.html'
|
||||||
|
*/
|
||||||
|
ext: string;
|
||||||
|
/**
|
||||||
|
* The file name without extension (if any) such as 'index'
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
}
|
||||||
|
interface FormatInputPathObject {
|
||||||
|
/**
|
||||||
|
* The root of the path such as '/' or 'c:\'
|
||||||
|
*/
|
||||||
|
root?: string | undefined;
|
||||||
|
/**
|
||||||
|
* The full directory path such as '/home/user/dir' or 'c:\path\dir'
|
||||||
|
*/
|
||||||
|
dir?: string | undefined;
|
||||||
|
/**
|
||||||
|
* The file name including extension (if any) such as 'index.html'
|
||||||
|
*/
|
||||||
|
base?: string | undefined;
|
||||||
|
/**
|
||||||
|
* The file extension (if any) such as '.html'
|
||||||
|
*/
|
||||||
|
ext?: string | undefined;
|
||||||
|
/**
|
||||||
|
* The file name without extension (if any) such as 'index'
|
||||||
|
*/
|
||||||
|
name?: string | undefined;
|
||||||
|
}
|
||||||
|
interface PlatformPath {
|
||||||
|
/**
|
||||||
|
* Normalize a string path, reducing '..' and '.' parts.
|
||||||
|
* When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. If the path is a zero-length string, '.' is returned, representing the current working directory.
|
||||||
|
*
|
||||||
|
* @param path string path to normalize.
|
||||||
|
* @throws {TypeError} if `path` is not a string.
|
||||||
|
*/
|
||||||
|
normalize(path: string): string;
|
||||||
|
/**
|
||||||
|
* Join all arguments together and normalize the resulting path.
|
||||||
|
*
|
||||||
|
* @param paths paths to join.
|
||||||
|
* @throws {TypeError} if any of the path segments is not a string.
|
||||||
|
*/
|
||||||
|
join(...paths: string[]): string;
|
||||||
|
/**
|
||||||
|
* The right-most parameter is considered {to}. Other parameters are considered an array of {from}.
|
||||||
|
*
|
||||||
|
* Starting from leftmost {from} parameter, resolves {to} to an absolute path.
|
||||||
|
*
|
||||||
|
* If {to} isn't already absolute, {from} arguments are prepended in right to left order,
|
||||||
|
* until an absolute path is found. If after using all {from} paths still no absolute path is found,
|
||||||
|
* the current working directory is used as well. The resulting path is normalized,
|
||||||
|
* and trailing slashes are removed unless the path gets resolved to the root directory.
|
||||||
|
*
|
||||||
|
* @param paths A sequence of paths or path segments.
|
||||||
|
* @throws {TypeError} if any of the arguments is not a string.
|
||||||
|
*/
|
||||||
|
resolve(...paths: string[]): string;
|
||||||
|
/**
|
||||||
|
* The `path.matchesGlob()` method determines if `path` matches the `pattern`.
|
||||||
|
* @param path The path to glob-match against.
|
||||||
|
* @param pattern The glob to check the path against.
|
||||||
|
* @returns Whether or not the `path` matched the `pattern`.
|
||||||
|
* @throws {TypeError} if `path` or `pattern` are not strings.
|
||||||
|
* @since v20.17.0
|
||||||
|
*/
|
||||||
|
matchesGlob(path: string, pattern: string): boolean;
|
||||||
|
/**
|
||||||
|
* Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.
|
||||||
|
*
|
||||||
|
* If the given {path} is a zero-length string, `false` will be returned.
|
||||||
|
*
|
||||||
|
* @param path path to test.
|
||||||
|
* @throws {TypeError} if `path` is not a string.
|
||||||
|
*/
|
||||||
|
isAbsolute(path: string): boolean;
|
||||||
|
/**
|
||||||
|
* Solve the relative path from {from} to {to} based on the current working directory.
|
||||||
|
* At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.
|
||||||
|
*
|
||||||
|
* @throws {TypeError} if either `from` or `to` is not a string.
|
||||||
|
*/
|
||||||
|
relative(from: string, to: string): string;
|
||||||
|
/**
|
||||||
|
* Return the directory name of a path. Similar to the Unix dirname command.
|
||||||
|
*
|
||||||
|
* @param path the path to evaluate.
|
||||||
|
* @throws {TypeError} if `path` is not a string.
|
||||||
|
*/
|
||||||
|
dirname(path: string): string;
|
||||||
|
/**
|
||||||
|
* Return the last portion of a path. Similar to the Unix basename command.
|
||||||
|
* Often used to extract the file name from a fully qualified path.
|
||||||
|
*
|
||||||
|
* @param path the path to evaluate.
|
||||||
|
* @param suffix optionally, an extension to remove from the result.
|
||||||
|
* @throws {TypeError} if `path` is not a string or if `ext` is given and is not a string.
|
||||||
|
*/
|
||||||
|
basename(path: string, suffix?: string): string;
|
||||||
|
/**
|
||||||
|
* Return the extension of the path, from the last '.' to end of string in the last portion of the path.
|
||||||
|
* If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string.
|
||||||
|
*
|
||||||
|
* @param path the path to evaluate.
|
||||||
|
* @throws {TypeError} if `path` is not a string.
|
||||||
|
*/
|
||||||
|
extname(path: string): string;
|
||||||
|
/**
|
||||||
|
* The platform-specific file separator. '\\' or '/'.
|
||||||
|
*/
|
||||||
|
readonly sep: "\\" | "/";
|
||||||
|
/**
|
||||||
|
* The platform-specific file delimiter. ';' or ':'.
|
||||||
|
*/
|
||||||
|
readonly delimiter: ";" | ":";
|
||||||
|
/**
|
||||||
|
* Returns an object from a path string - the opposite of format().
|
||||||
|
*
|
||||||
|
* @param path path to evaluate.
|
||||||
|
* @throws {TypeError} if `path` is not a string.
|
||||||
|
*/
|
||||||
|
parse(path: string): ParsedPath;
|
||||||
|
/**
|
||||||
|
* Returns a path string from an object - the opposite of parse().
|
||||||
|
*
|
||||||
|
* @param pathObject path to evaluate.
|
||||||
|
*/
|
||||||
|
format(pathObject: FormatInputPathObject): string;
|
||||||
|
/**
|
||||||
|
* On Windows systems only, returns an equivalent namespace-prefixed path for the given path.
|
||||||
|
* If path is not a string, path will be returned without modifications.
|
||||||
|
* This method is meaningful only on Windows system.
|
||||||
|
* On POSIX systems, the method is non-operational and always returns path without modifications.
|
||||||
|
*/
|
||||||
|
toNamespacedPath(path: string): string;
|
||||||
|
/**
|
||||||
|
* Posix specific pathing.
|
||||||
|
* Same as parent object on posix.
|
||||||
|
*/
|
||||||
|
readonly posix: PlatformPath;
|
||||||
|
/**
|
||||||
|
* Windows specific pathing.
|
||||||
|
* Same as parent object on windows
|
||||||
|
*/
|
||||||
|
readonly win32: PlatformPath;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const path: path.PlatformPath;
|
||||||
|
export = path;
|
||||||
|
}
|
||||||
|
declare module "node:path" {
|
||||||
|
import path = require("path");
|
||||||
|
export = path;
|
||||||
|
}
|
||||||
|
declare module "node:path/posix" {
|
||||||
|
import path = require("path/posix");
|
||||||
|
export = path;
|
||||||
|
}
|
||||||
|
declare module "node:path/win32" {
|
||||||
|
import path = require("path/win32");
|
||||||
|
export = path;
|
||||||
|
}
|
||||||
+961
@@ -0,0 +1,961 @@
|
|||||||
|
/**
|
||||||
|
* This module provides an implementation of a subset of the W3C [Web Performance APIs](https://w3c.github.io/perf-timing-primer/) as well as additional APIs for
|
||||||
|
* Node.js-specific performance measurements.
|
||||||
|
*
|
||||||
|
* Node.js supports the following [Web Performance APIs](https://w3c.github.io/perf-timing-primer/):
|
||||||
|
*
|
||||||
|
* * [High Resolution Time](https://www.w3.org/TR/hr-time-2)
|
||||||
|
* * [Performance Timeline](https://w3c.github.io/performance-timeline/)
|
||||||
|
* * [User Timing](https://www.w3.org/TR/user-timing/)
|
||||||
|
* * [Resource Timing](https://www.w3.org/TR/resource-timing-2/)
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { PerformanceObserver, performance } from 'node:perf_hooks';
|
||||||
|
*
|
||||||
|
* const obs = new PerformanceObserver((items) => {
|
||||||
|
* console.log(items.getEntries()[0].duration);
|
||||||
|
* performance.clearMarks();
|
||||||
|
* });
|
||||||
|
* obs.observe({ type: 'measure' });
|
||||||
|
* performance.measure('Start to Now');
|
||||||
|
*
|
||||||
|
* performance.mark('A');
|
||||||
|
* doSomeLongRunningProcess(() => {
|
||||||
|
* performance.measure('A to Now', 'A');
|
||||||
|
*
|
||||||
|
* performance.mark('B');
|
||||||
|
* performance.measure('A to B', 'A', 'B');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
* @see [source](https://github.com/nodejs/node/blob/v20.13.1/lib/perf_hooks.js)
|
||||||
|
*/
|
||||||
|
declare module "perf_hooks" {
|
||||||
|
import { AsyncResource } from "node:async_hooks";
|
||||||
|
type EntryType =
|
||||||
|
| "dns" // Node.js only
|
||||||
|
| "function" // Node.js only
|
||||||
|
| "gc" // Node.js only
|
||||||
|
| "http2" // Node.js only
|
||||||
|
| "http" // Node.js only
|
||||||
|
| "mark" // available on the Web
|
||||||
|
| "measure" // available on the Web
|
||||||
|
| "net" // Node.js only
|
||||||
|
| "node" // Node.js only
|
||||||
|
| "resource"; // available on the Web
|
||||||
|
interface NodeGCPerformanceDetail {
|
||||||
|
/**
|
||||||
|
* When `performanceEntry.entryType` is equal to 'gc', the `performance.kind` property identifies
|
||||||
|
* the type of garbage collection operation that occurred.
|
||||||
|
* See perf_hooks.constants for valid values.
|
||||||
|
*/
|
||||||
|
readonly kind: number;
|
||||||
|
/**
|
||||||
|
* When `performanceEntry.entryType` is equal to 'gc', the `performance.flags`
|
||||||
|
* property contains additional information about garbage collection operation.
|
||||||
|
* See perf_hooks.constants for valid values.
|
||||||
|
*/
|
||||||
|
readonly flags: number;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* The constructor of this class is not exposed to users directly.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
class PerformanceEntry {
|
||||||
|
protected constructor();
|
||||||
|
/**
|
||||||
|
* The total number of milliseconds elapsed for this entry. This value will not
|
||||||
|
* be meaningful for all Performance Entry types.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly duration: number;
|
||||||
|
/**
|
||||||
|
* The name of the performance entry.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly name: string;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp marking the starting time of the
|
||||||
|
* Performance Entry.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly startTime: number;
|
||||||
|
/**
|
||||||
|
* The type of the performance entry. It may be one of:
|
||||||
|
*
|
||||||
|
* * `'node'` (Node.js only)
|
||||||
|
* * `'mark'` (available on the Web)
|
||||||
|
* * `'measure'` (available on the Web)
|
||||||
|
* * `'gc'` (Node.js only)
|
||||||
|
* * `'function'` (Node.js only)
|
||||||
|
* * `'http2'` (Node.js only)
|
||||||
|
* * `'http'` (Node.js only)
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly entryType: EntryType;
|
||||||
|
toJSON(): any;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Exposes marks created via the `Performance.mark()` method.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
class PerformanceMark extends PerformanceEntry {
|
||||||
|
readonly detail: any;
|
||||||
|
readonly duration: 0;
|
||||||
|
readonly entryType: "mark";
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Exposes measures created via the `Performance.measure()` method.
|
||||||
|
*
|
||||||
|
* The constructor of this class is not exposed to users directly.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
class PerformanceMeasure extends PerformanceEntry {
|
||||||
|
readonly detail: any;
|
||||||
|
readonly entryType: "measure";
|
||||||
|
}
|
||||||
|
interface UVMetrics {
|
||||||
|
/**
|
||||||
|
* Number of event loop iterations.
|
||||||
|
*/
|
||||||
|
readonly loopCount: number;
|
||||||
|
/**
|
||||||
|
* Number of events that have been processed by the event handler.
|
||||||
|
*/
|
||||||
|
readonly events: number;
|
||||||
|
/**
|
||||||
|
* Number of events that were waiting to be processed when the event provider was called.
|
||||||
|
*/
|
||||||
|
readonly eventsWaiting: number;
|
||||||
|
}
|
||||||
|
// TODO: PerformanceNodeEntry is missing
|
||||||
|
/**
|
||||||
|
* _This property is an extension by Node.js. It is not available in Web browsers._
|
||||||
|
*
|
||||||
|
* Provides timing details for Node.js itself. The constructor of this class
|
||||||
|
* is not exposed to users.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
class PerformanceNodeTiming extends PerformanceEntry {
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp at which the Node.js process
|
||||||
|
* completed bootstrapping. If bootstrapping has not yet finished, the property
|
||||||
|
* has the value of -1.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly bootstrapComplete: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp at which the Node.js environment was
|
||||||
|
* initialized.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly environment: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp of the amount of time the event loop
|
||||||
|
* has been idle within the event loop's event provider (e.g. `epoll_wait`). This
|
||||||
|
* does not take CPU usage into consideration. If the event loop has not yet
|
||||||
|
* started (e.g., in the first tick of the main script), the property has the
|
||||||
|
* value of 0.
|
||||||
|
* @since v14.10.0, v12.19.0
|
||||||
|
*/
|
||||||
|
readonly idleTime: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp at which the Node.js event loop
|
||||||
|
* exited. If the event loop has not yet exited, the property has the value of -1\.
|
||||||
|
* It can only have a value of not -1 in a handler of the `'exit'` event.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly loopExit: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp at which the Node.js event loop
|
||||||
|
* started. If the event loop has not yet started (e.g., in the first tick of the
|
||||||
|
* main script), the property has the value of -1.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly loopStart: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp at which the Node.js process was initialized.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly nodeStart: number;
|
||||||
|
/**
|
||||||
|
* This is a wrapper to the `uv_metrics_info` function.
|
||||||
|
* It returns the current set of event loop metrics.
|
||||||
|
*
|
||||||
|
* It is recommended to use this property inside a function whose execution was
|
||||||
|
* scheduled using `setImmediate` to avoid collecting metrics before finishing all
|
||||||
|
* operations scheduled during the current loop iteration.
|
||||||
|
* @since v20.18.0
|
||||||
|
*/
|
||||||
|
readonly uvMetricsInfo: UVMetrics;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp at which the V8 platform was
|
||||||
|
* initialized.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly v8Start: number;
|
||||||
|
}
|
||||||
|
interface EventLoopUtilization {
|
||||||
|
idle: number;
|
||||||
|
active: number;
|
||||||
|
utilization: number;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* @param utilization1 The result of a previous call to `eventLoopUtilization()`.
|
||||||
|
* @param utilization2 The result of a previous call to `eventLoopUtilization()` prior to `utilization1`.
|
||||||
|
*/
|
||||||
|
type EventLoopUtilityFunction = (
|
||||||
|
utilization1?: EventLoopUtilization,
|
||||||
|
utilization2?: EventLoopUtilization,
|
||||||
|
) => EventLoopUtilization;
|
||||||
|
interface MarkOptions {
|
||||||
|
/**
|
||||||
|
* Additional optional detail to include with the mark.
|
||||||
|
*/
|
||||||
|
detail?: unknown | undefined;
|
||||||
|
/**
|
||||||
|
* An optional timestamp to be used as the mark time.
|
||||||
|
* @default `performance.now()`
|
||||||
|
*/
|
||||||
|
startTime?: number | undefined;
|
||||||
|
}
|
||||||
|
interface MeasureOptions {
|
||||||
|
/**
|
||||||
|
* Additional optional detail to include with the mark.
|
||||||
|
*/
|
||||||
|
detail?: unknown;
|
||||||
|
/**
|
||||||
|
* Duration between start and end times.
|
||||||
|
*/
|
||||||
|
duration?: number | undefined;
|
||||||
|
/**
|
||||||
|
* Timestamp to be used as the end time, or a string identifying a previously recorded mark.
|
||||||
|
*/
|
||||||
|
end?: number | string | undefined;
|
||||||
|
/**
|
||||||
|
* Timestamp to be used as the start time, or a string identifying a previously recorded mark.
|
||||||
|
*/
|
||||||
|
start?: number | string | undefined;
|
||||||
|
}
|
||||||
|
interface TimerifyOptions {
|
||||||
|
/**
|
||||||
|
* A histogram object created using `perf_hooks.createHistogram()` that will record runtime
|
||||||
|
* durations in nanoseconds.
|
||||||
|
*/
|
||||||
|
histogram?: RecordableHistogram | undefined;
|
||||||
|
}
|
||||||
|
interface Performance {
|
||||||
|
/**
|
||||||
|
* If `name` is not provided, removes all `PerformanceMark` objects from the Performance Timeline.
|
||||||
|
* If `name` is provided, removes only the named mark.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
clearMarks(name?: string): void;
|
||||||
|
/**
|
||||||
|
* If `name` is not provided, removes all `PerformanceMeasure` objects from the Performance Timeline.
|
||||||
|
* If `name` is provided, removes only the named measure.
|
||||||
|
* @since v16.7.0
|
||||||
|
*/
|
||||||
|
clearMeasures(name?: string): void;
|
||||||
|
/**
|
||||||
|
* If `name` is not provided, removes all `PerformanceResourceTiming` objects from the Resource Timeline.
|
||||||
|
* If `name` is provided, removes only the named resource.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
clearResourceTimings(name?: string): void;
|
||||||
|
/**
|
||||||
|
* eventLoopUtilization is similar to CPU utilization except that it is calculated using high precision wall-clock time.
|
||||||
|
* It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait).
|
||||||
|
* No other CPU idle time is taken into consideration.
|
||||||
|
*/
|
||||||
|
eventLoopUtilization: EventLoopUtilityFunction;
|
||||||
|
/**
|
||||||
|
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`.
|
||||||
|
* If you are only interested in performance entries of certain types or that have certain names, see
|
||||||
|
* `performance.getEntriesByType()` and `performance.getEntriesByName()`.
|
||||||
|
* @since v16.7.0
|
||||||
|
*/
|
||||||
|
getEntries(): PerformanceEntry[];
|
||||||
|
/**
|
||||||
|
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
|
||||||
|
* whose `performanceEntry.name` is equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to `type`.
|
||||||
|
* @param name
|
||||||
|
* @param type
|
||||||
|
* @since v16.7.0
|
||||||
|
*/
|
||||||
|
getEntriesByName(name: string, type?: EntryType): PerformanceEntry[];
|
||||||
|
/**
|
||||||
|
* Returns a list of `PerformanceEntry` objects in chronological order with respect to `performanceEntry.startTime`
|
||||||
|
* whose `performanceEntry.entryType` is equal to `type`.
|
||||||
|
* @param type
|
||||||
|
* @since v16.7.0
|
||||||
|
*/
|
||||||
|
getEntriesByType(type: EntryType): PerformanceEntry[];
|
||||||
|
/**
|
||||||
|
* Creates a new `PerformanceMark` entry in the Performance Timeline.
|
||||||
|
* A `PerformanceMark` is a subclass of `PerformanceEntry` whose `performanceEntry.entryType` is always `'mark'`,
|
||||||
|
* and whose `performanceEntry.duration` is always `0`.
|
||||||
|
* Performance marks are used to mark specific significant moments in the Performance Timeline.
|
||||||
|
*
|
||||||
|
* The created `PerformanceMark` entry is put in the global Performance Timeline and can be queried with
|
||||||
|
* `performance.getEntries`, `performance.getEntriesByName`, and `performance.getEntriesByType`. When the observation is
|
||||||
|
* performed, the entries should be cleared from the global Performance Timeline manually with `performance.clearMarks`.
|
||||||
|
* @param name
|
||||||
|
*/
|
||||||
|
mark(name: string, options?: MarkOptions): PerformanceMark;
|
||||||
|
/**
|
||||||
|
* Creates a new `PerformanceResourceTiming` entry in the Resource Timeline.
|
||||||
|
* A `PerformanceResourceTiming` is a subclass of `PerformanceEntry` whose `performanceEntry.entryType` is always `'resource'`.
|
||||||
|
* Performance resources are used to mark moments in the Resource Timeline.
|
||||||
|
* @param timingInfo [Fetch Timing Info](https://fetch.spec.whatwg.org/#fetch-timing-info)
|
||||||
|
* @param requestedUrl The resource url
|
||||||
|
* @param initiatorType The initiator name, e.g: 'fetch'
|
||||||
|
* @param global
|
||||||
|
* @param cacheMode The cache mode must be an empty string ('') or 'local'
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
markResourceTiming(
|
||||||
|
timingInfo: object,
|
||||||
|
requestedUrl: string,
|
||||||
|
initiatorType: string,
|
||||||
|
global: object,
|
||||||
|
cacheMode: "" | "local",
|
||||||
|
): PerformanceResourceTiming;
|
||||||
|
/**
|
||||||
|
* Creates a new PerformanceMeasure entry in the Performance Timeline.
|
||||||
|
* A PerformanceMeasure is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'measure',
|
||||||
|
* and whose performanceEntry.duration measures the number of milliseconds elapsed since startMark and endMark.
|
||||||
|
*
|
||||||
|
* The startMark argument may identify any existing PerformanceMark in the the Performance Timeline, or may identify
|
||||||
|
* any of the timestamp properties provided by the PerformanceNodeTiming class. If the named startMark does not exist,
|
||||||
|
* then startMark is set to timeOrigin by default.
|
||||||
|
*
|
||||||
|
* The endMark argument must identify any existing PerformanceMark in the the Performance Timeline or any of the timestamp
|
||||||
|
* properties provided by the PerformanceNodeTiming class. If the named endMark does not exist, an error will be thrown.
|
||||||
|
* @param name
|
||||||
|
* @param startMark
|
||||||
|
* @param endMark
|
||||||
|
* @return The PerformanceMeasure entry that was created
|
||||||
|
*/
|
||||||
|
measure(name: string, startMark?: string, endMark?: string): PerformanceMeasure;
|
||||||
|
measure(name: string, options: MeasureOptions): PerformanceMeasure;
|
||||||
|
/**
|
||||||
|
* _This property is an extension by Node.js. It is not available in Web browsers._
|
||||||
|
*
|
||||||
|
* An instance of the `PerformanceNodeTiming` class that provides performance metrics for specific Node.js operational milestones.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly nodeTiming: PerformanceNodeTiming;
|
||||||
|
/**
|
||||||
|
* Returns the current high resolution millisecond timestamp, where 0 represents the start of the current `node` process.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
now(): number;
|
||||||
|
/**
|
||||||
|
* Sets the global performance resource timing buffer size to the specified number of "resource" type performance entry objects.
|
||||||
|
*
|
||||||
|
* By default the max buffer size is set to 250.
|
||||||
|
* @since v18.8.0
|
||||||
|
*/
|
||||||
|
setResourceTimingBufferSize(maxSize: number): void;
|
||||||
|
/**
|
||||||
|
* The [`timeOrigin`](https://w3c.github.io/hr-time/#dom-performance-timeorigin) specifies the high resolution millisecond timestamp
|
||||||
|
* at which the current `node` process began, measured in Unix time.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
readonly timeOrigin: number;
|
||||||
|
/**
|
||||||
|
* _This property is an extension by Node.js. It is not available in Web browsers._
|
||||||
|
*
|
||||||
|
* Wraps a function within a new function that measures the running time of the wrapped function.
|
||||||
|
* A `PerformanceObserver` must be subscribed to the `'function'` event type in order for the timing details to be accessed.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import {
|
||||||
|
* performance,
|
||||||
|
* PerformanceObserver,
|
||||||
|
* } from 'node:perf_hooks';
|
||||||
|
*
|
||||||
|
* function someFunction() {
|
||||||
|
* console.log('hello world');
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* const wrapped = performance.timerify(someFunction);
|
||||||
|
*
|
||||||
|
* const obs = new PerformanceObserver((list) => {
|
||||||
|
* console.log(list.getEntries()[0].duration);
|
||||||
|
*
|
||||||
|
* performance.clearMarks();
|
||||||
|
* performance.clearMeasures();
|
||||||
|
* obs.disconnect();
|
||||||
|
* });
|
||||||
|
* obs.observe({ entryTypes: ['function'] });
|
||||||
|
*
|
||||||
|
* // A performance timeline entry will be created
|
||||||
|
* wrapped();
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* If the wrapped function returns a promise, a finally handler will be attached to the promise and the duration will be reported
|
||||||
|
* once the finally handler is invoked.
|
||||||
|
* @param fn
|
||||||
|
*/
|
||||||
|
timerify<T extends (...params: any[]) => any>(fn: T, options?: TimerifyOptions): T;
|
||||||
|
/**
|
||||||
|
* An object which is JSON representation of the performance object. It is similar to
|
||||||
|
* [`window.performance.toJSON`](https://developer.mozilla.org/en-US/docs/Web/API/Performance/toJSON) in browsers.
|
||||||
|
* @since v16.1.0
|
||||||
|
*/
|
||||||
|
toJSON(): any;
|
||||||
|
}
|
||||||
|
class PerformanceObserverEntryList {
|
||||||
|
/**
|
||||||
|
* Returns a list of `PerformanceEntry` objects in chronological order
|
||||||
|
* with respect to `performanceEntry.startTime`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import {
|
||||||
|
* performance,
|
||||||
|
* PerformanceObserver,
|
||||||
|
* } from 'node:perf_hooks';
|
||||||
|
*
|
||||||
|
* const obs = new PerformanceObserver((perfObserverList, observer) => {
|
||||||
|
* console.log(perfObserverList.getEntries());
|
||||||
|
*
|
||||||
|
* * [
|
||||||
|
* * PerformanceEntry {
|
||||||
|
* * name: 'test',
|
||||||
|
* * entryType: 'mark',
|
||||||
|
* * startTime: 81.465639,
|
||||||
|
* * duration: 0,
|
||||||
|
* * detail: null
|
||||||
|
* * },
|
||||||
|
* * PerformanceEntry {
|
||||||
|
* * name: 'meow',
|
||||||
|
* * entryType: 'mark',
|
||||||
|
* * startTime: 81.860064,
|
||||||
|
* * duration: 0,
|
||||||
|
* * detail: null
|
||||||
|
* * }
|
||||||
|
* * ]
|
||||||
|
*
|
||||||
|
* performance.clearMarks();
|
||||||
|
* performance.clearMeasures();
|
||||||
|
* observer.disconnect();
|
||||||
|
* });
|
||||||
|
* obs.observe({ type: 'mark' });
|
||||||
|
*
|
||||||
|
* performance.mark('test');
|
||||||
|
* performance.mark('meow');
|
||||||
|
* ```
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
getEntries(): PerformanceEntry[];
|
||||||
|
/**
|
||||||
|
* Returns a list of `PerformanceEntry` objects in chronological order
|
||||||
|
* with respect to `performanceEntry.startTime` whose `performanceEntry.name` is
|
||||||
|
* equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to`type`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import {
|
||||||
|
* performance,
|
||||||
|
* PerformanceObserver,
|
||||||
|
* } from 'node:perf_hooks';
|
||||||
|
*
|
||||||
|
* const obs = new PerformanceObserver((perfObserverList, observer) => {
|
||||||
|
* console.log(perfObserverList.getEntriesByName('meow'));
|
||||||
|
*
|
||||||
|
* * [
|
||||||
|
* * PerformanceEntry {
|
||||||
|
* * name: 'meow',
|
||||||
|
* * entryType: 'mark',
|
||||||
|
* * startTime: 98.545991,
|
||||||
|
* * duration: 0,
|
||||||
|
* * detail: null
|
||||||
|
* * }
|
||||||
|
* * ]
|
||||||
|
*
|
||||||
|
* console.log(perfObserverList.getEntriesByName('nope')); // []
|
||||||
|
*
|
||||||
|
* console.log(perfObserverList.getEntriesByName('test', 'mark'));
|
||||||
|
*
|
||||||
|
* * [
|
||||||
|
* * PerformanceEntry {
|
||||||
|
* * name: 'test',
|
||||||
|
* * entryType: 'mark',
|
||||||
|
* * startTime: 63.518931,
|
||||||
|
* * duration: 0,
|
||||||
|
* * detail: null
|
||||||
|
* * }
|
||||||
|
* * ]
|
||||||
|
*
|
||||||
|
* console.log(perfObserverList.getEntriesByName('test', 'measure')); // []
|
||||||
|
*
|
||||||
|
* performance.clearMarks();
|
||||||
|
* performance.clearMeasures();
|
||||||
|
* observer.disconnect();
|
||||||
|
* });
|
||||||
|
* obs.observe({ entryTypes: ['mark', 'measure'] });
|
||||||
|
*
|
||||||
|
* performance.mark('test');
|
||||||
|
* performance.mark('meow');
|
||||||
|
* ```
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
getEntriesByName(name: string, type?: EntryType): PerformanceEntry[];
|
||||||
|
/**
|
||||||
|
* Returns a list of `PerformanceEntry` objects in chronological order
|
||||||
|
* with respect to `performanceEntry.startTime` whose `performanceEntry.entryType` is equal to `type`.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import {
|
||||||
|
* performance,
|
||||||
|
* PerformanceObserver,
|
||||||
|
* } from 'node:perf_hooks';
|
||||||
|
*
|
||||||
|
* const obs = new PerformanceObserver((perfObserverList, observer) => {
|
||||||
|
* console.log(perfObserverList.getEntriesByType('mark'));
|
||||||
|
*
|
||||||
|
* * [
|
||||||
|
* * PerformanceEntry {
|
||||||
|
* * name: 'test',
|
||||||
|
* * entryType: 'mark',
|
||||||
|
* * startTime: 55.897834,
|
||||||
|
* * duration: 0,
|
||||||
|
* * detail: null
|
||||||
|
* * },
|
||||||
|
* * PerformanceEntry {
|
||||||
|
* * name: 'meow',
|
||||||
|
* * entryType: 'mark',
|
||||||
|
* * startTime: 56.350146,
|
||||||
|
* * duration: 0,
|
||||||
|
* * detail: null
|
||||||
|
* * }
|
||||||
|
* * ]
|
||||||
|
*
|
||||||
|
* performance.clearMarks();
|
||||||
|
* performance.clearMeasures();
|
||||||
|
* observer.disconnect();
|
||||||
|
* });
|
||||||
|
* obs.observe({ type: 'mark' });
|
||||||
|
*
|
||||||
|
* performance.mark('test');
|
||||||
|
* performance.mark('meow');
|
||||||
|
* ```
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
getEntriesByType(type: EntryType): PerformanceEntry[];
|
||||||
|
}
|
||||||
|
type PerformanceObserverCallback = (list: PerformanceObserverEntryList, observer: PerformanceObserver) => void;
|
||||||
|
/**
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
class PerformanceObserver extends AsyncResource {
|
||||||
|
constructor(callback: PerformanceObserverCallback);
|
||||||
|
/**
|
||||||
|
* Disconnects the `PerformanceObserver` instance from all notifications.
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
disconnect(): void;
|
||||||
|
/**
|
||||||
|
* Subscribes the `PerformanceObserver` instance to notifications of new `PerformanceEntry` instances identified either by `options.entryTypes` or `options.type`:
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import {
|
||||||
|
* performance,
|
||||||
|
* PerformanceObserver,
|
||||||
|
* } from 'node:perf_hooks';
|
||||||
|
*
|
||||||
|
* const obs = new PerformanceObserver((list, observer) => {
|
||||||
|
* // Called once asynchronously. `list` contains three items.
|
||||||
|
* });
|
||||||
|
* obs.observe({ type: 'mark' });
|
||||||
|
*
|
||||||
|
* for (let n = 0; n < 3; n++)
|
||||||
|
* performance.mark(`test${n}`);
|
||||||
|
* ```
|
||||||
|
* @since v8.5.0
|
||||||
|
*/
|
||||||
|
observe(
|
||||||
|
options:
|
||||||
|
| {
|
||||||
|
entryTypes: readonly EntryType[];
|
||||||
|
buffered?: boolean | undefined;
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
type: EntryType;
|
||||||
|
buffered?: boolean | undefined;
|
||||||
|
},
|
||||||
|
): void;
|
||||||
|
/**
|
||||||
|
* @since v16.0.0
|
||||||
|
* @returns Current list of entries stored in the performance observer, emptying it out.
|
||||||
|
*/
|
||||||
|
takeRecords(): PerformanceEntry[];
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Provides detailed network timing data regarding the loading of an application's resources.
|
||||||
|
*
|
||||||
|
* The constructor of this class is not exposed to users directly.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
class PerformanceResourceTiming extends PerformanceEntry {
|
||||||
|
readonly entryType: "resource";
|
||||||
|
protected constructor();
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp at immediately before dispatching the `fetch`
|
||||||
|
* request. If the resource is not intercepted by a worker the property will always return 0.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly workerStart: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp that represents the start time of the fetch which
|
||||||
|
* initiates the redirect.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly redirectStart: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp that will be created immediately after receiving
|
||||||
|
* the last byte of the response of the last redirect.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly redirectEnd: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp immediately before the Node.js starts to fetch the resource.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly fetchStart: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp immediately before the Node.js starts the domain name lookup
|
||||||
|
* for the resource.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly domainLookupStart: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp representing the time immediately after the Node.js finished
|
||||||
|
* the domain name lookup for the resource.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly domainLookupEnd: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp representing the time immediately before Node.js starts to
|
||||||
|
* establish the connection to the server to retrieve the resource.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly connectStart: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp representing the time immediately after Node.js finishes
|
||||||
|
* establishing the connection to the server to retrieve the resource.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly connectEnd: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp representing the time immediately before Node.js starts the
|
||||||
|
* handshake process to secure the current connection.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly secureConnectionStart: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp representing the time immediately before Node.js receives the
|
||||||
|
* first byte of the response from the server.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly requestStart: number;
|
||||||
|
/**
|
||||||
|
* The high resolution millisecond timestamp representing the time immediately after Node.js receives the
|
||||||
|
* last byte of the resource or immediately before the transport connection is closed, whichever comes first.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly responseEnd: number;
|
||||||
|
/**
|
||||||
|
* A number representing the size (in octets) of the fetched resource. The size includes the response header
|
||||||
|
* fields plus the response payload body.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly transferSize: number;
|
||||||
|
/**
|
||||||
|
* A number representing the size (in octets) received from the fetch (HTTP or cache), of the payload body, before
|
||||||
|
* removing any applied content-codings.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly encodedBodySize: number;
|
||||||
|
/**
|
||||||
|
* A number representing the size (in octets) received from the fetch (HTTP or cache), of the message body, after
|
||||||
|
* removing any applied content-codings.
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
readonly decodedBodySize: number;
|
||||||
|
/**
|
||||||
|
* Returns a `object` that is the JSON representation of the `PerformanceResourceTiming` object
|
||||||
|
* @since v18.2.0, v16.17.0
|
||||||
|
*/
|
||||||
|
toJSON(): any;
|
||||||
|
}
|
||||||
|
namespace constants {
|
||||||
|
const NODE_PERFORMANCE_GC_MAJOR: number;
|
||||||
|
const NODE_PERFORMANCE_GC_MINOR: number;
|
||||||
|
const NODE_PERFORMANCE_GC_INCREMENTAL: number;
|
||||||
|
const NODE_PERFORMANCE_GC_WEAKCB: number;
|
||||||
|
const NODE_PERFORMANCE_GC_FLAGS_NO: number;
|
||||||
|
const NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED: number;
|
||||||
|
const NODE_PERFORMANCE_GC_FLAGS_FORCED: number;
|
||||||
|
const NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING: number;
|
||||||
|
const NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE: number;
|
||||||
|
const NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY: number;
|
||||||
|
const NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE: number;
|
||||||
|
}
|
||||||
|
const performance: Performance;
|
||||||
|
interface EventLoopMonitorOptions {
|
||||||
|
/**
|
||||||
|
* The sampling rate in milliseconds.
|
||||||
|
* Must be greater than zero.
|
||||||
|
* @default 10
|
||||||
|
*/
|
||||||
|
resolution?: number | undefined;
|
||||||
|
}
|
||||||
|
interface Histogram {
|
||||||
|
/**
|
||||||
|
* The number of samples recorded by the histogram.
|
||||||
|
* @since v17.4.0, v16.14.0
|
||||||
|
*/
|
||||||
|
readonly count: number;
|
||||||
|
/**
|
||||||
|
* The number of samples recorded by the histogram.
|
||||||
|
* v17.4.0, v16.14.0
|
||||||
|
*/
|
||||||
|
readonly countBigInt: bigint;
|
||||||
|
/**
|
||||||
|
* The number of times the event loop delay exceeded the maximum 1 hour event
|
||||||
|
* loop delay threshold.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
readonly exceeds: number;
|
||||||
|
/**
|
||||||
|
* The number of times the event loop delay exceeded the maximum 1 hour event loop delay threshold.
|
||||||
|
* @since v17.4.0, v16.14.0
|
||||||
|
*/
|
||||||
|
readonly exceedsBigInt: bigint;
|
||||||
|
/**
|
||||||
|
* The maximum recorded event loop delay.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
readonly max: number;
|
||||||
|
/**
|
||||||
|
* The maximum recorded event loop delay.
|
||||||
|
* v17.4.0, v16.14.0
|
||||||
|
*/
|
||||||
|
readonly maxBigInt: number;
|
||||||
|
/**
|
||||||
|
* The mean of the recorded event loop delays.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
readonly mean: number;
|
||||||
|
/**
|
||||||
|
* The minimum recorded event loop delay.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
readonly min: number;
|
||||||
|
/**
|
||||||
|
* The minimum recorded event loop delay.
|
||||||
|
* v17.4.0, v16.14.0
|
||||||
|
*/
|
||||||
|
readonly minBigInt: bigint;
|
||||||
|
/**
|
||||||
|
* Returns the value at the given percentile.
|
||||||
|
* @since v11.10.0
|
||||||
|
* @param percentile A percentile value in the range (0, 100].
|
||||||
|
*/
|
||||||
|
percentile(percentile: number): number;
|
||||||
|
/**
|
||||||
|
* Returns the value at the given percentile.
|
||||||
|
* @since v17.4.0, v16.14.0
|
||||||
|
* @param percentile A percentile value in the range (0, 100].
|
||||||
|
*/
|
||||||
|
percentileBigInt(percentile: number): bigint;
|
||||||
|
/**
|
||||||
|
* Returns a `Map` object detailing the accumulated percentile distribution.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
readonly percentiles: Map<number, number>;
|
||||||
|
/**
|
||||||
|
* Returns a `Map` object detailing the accumulated percentile distribution.
|
||||||
|
* @since v17.4.0, v16.14.0
|
||||||
|
*/
|
||||||
|
readonly percentilesBigInt: Map<bigint, bigint>;
|
||||||
|
/**
|
||||||
|
* Resets the collected histogram data.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
reset(): void;
|
||||||
|
/**
|
||||||
|
* The standard deviation of the recorded event loop delays.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
readonly stddev: number;
|
||||||
|
}
|
||||||
|
interface IntervalHistogram extends Histogram {
|
||||||
|
/**
|
||||||
|
* Enables the update interval timer. Returns `true` if the timer was
|
||||||
|
* started, `false` if it was already started.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
enable(): boolean;
|
||||||
|
/**
|
||||||
|
* Disables the update interval timer. Returns `true` if the timer was
|
||||||
|
* stopped, `false` if it was already stopped.
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
disable(): boolean;
|
||||||
|
}
|
||||||
|
interface RecordableHistogram extends Histogram {
|
||||||
|
/**
|
||||||
|
* @since v15.9.0, v14.18.0
|
||||||
|
* @param val The amount to record in the histogram.
|
||||||
|
*/
|
||||||
|
record(val: number | bigint): void;
|
||||||
|
/**
|
||||||
|
* Calculates the amount of time (in nanoseconds) that has passed since the
|
||||||
|
* previous call to `recordDelta()` and records that amount in the histogram.
|
||||||
|
* @since v15.9.0, v14.18.0
|
||||||
|
*/
|
||||||
|
recordDelta(): void;
|
||||||
|
/**
|
||||||
|
* Adds the values from `other` to this histogram.
|
||||||
|
* @since v17.4.0, v16.14.0
|
||||||
|
*/
|
||||||
|
add(other: RecordableHistogram): void;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* _This property is an extension by Node.js. It is not available in Web browsers._
|
||||||
|
*
|
||||||
|
* Creates an `IntervalHistogram` object that samples and reports the event loop
|
||||||
|
* delay over time. The delays will be reported in nanoseconds.
|
||||||
|
*
|
||||||
|
* Using a timer to detect approximate event loop delay works because the
|
||||||
|
* execution of timers is tied specifically to the lifecycle of the libuv
|
||||||
|
* event loop. That is, a delay in the loop will cause a delay in the execution
|
||||||
|
* of the timer, and those delays are specifically what this API is intended to
|
||||||
|
* detect.
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* import { monitorEventLoopDelay } from 'node:perf_hooks';
|
||||||
|
* const h = monitorEventLoopDelay({ resolution: 20 });
|
||||||
|
* h.enable();
|
||||||
|
* // Do something.
|
||||||
|
* h.disable();
|
||||||
|
* console.log(h.min);
|
||||||
|
* console.log(h.max);
|
||||||
|
* console.log(h.mean);
|
||||||
|
* console.log(h.stddev);
|
||||||
|
* console.log(h.percentiles);
|
||||||
|
* console.log(h.percentile(50));
|
||||||
|
* console.log(h.percentile(99));
|
||||||
|
* ```
|
||||||
|
* @since v11.10.0
|
||||||
|
*/
|
||||||
|
function monitorEventLoopDelay(options?: EventLoopMonitorOptions): IntervalHistogram;
|
||||||
|
interface CreateHistogramOptions {
|
||||||
|
/**
|
||||||
|
* The minimum recordable value. Must be an integer value greater than 0.
|
||||||
|
* @default 1
|
||||||
|
*/
|
||||||
|
lowest?: number | bigint | undefined;
|
||||||
|
/**
|
||||||
|
* The maximum recordable value. Must be an integer value greater than min.
|
||||||
|
* @default Number.MAX_SAFE_INTEGER
|
||||||
|
*/
|
||||||
|
highest?: number | bigint | undefined;
|
||||||
|
/**
|
||||||
|
* The number of accuracy digits. Must be a number between 1 and 5.
|
||||||
|
* @default 3
|
||||||
|
*/
|
||||||
|
figures?: number | undefined;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Returns a `RecordableHistogram`.
|
||||||
|
* @since v15.9.0, v14.18.0
|
||||||
|
*/
|
||||||
|
function createHistogram(options?: CreateHistogramOptions): RecordableHistogram;
|
||||||
|
import {
|
||||||
|
performance as _performance,
|
||||||
|
PerformanceEntry as _PerformanceEntry,
|
||||||
|
PerformanceMark as _PerformanceMark,
|
||||||
|
PerformanceMeasure as _PerformanceMeasure,
|
||||||
|
PerformanceObserver as _PerformanceObserver,
|
||||||
|
PerformanceObserverEntryList as _PerformanceObserverEntryList,
|
||||||
|
PerformanceResourceTiming as _PerformanceResourceTiming,
|
||||||
|
} from "perf_hooks";
|
||||||
|
global {
|
||||||
|
/**
|
||||||
|
* `PerformanceEntry` is a global reference for `import { PerformanceEntry } from 'node:node:perf_hooks'`
|
||||||
|
* @see https://nodejs.org/docs/latest-v20.x/api/globals.html#performanceentry
|
||||||
|
* @since v19.0.0
|
||||||
|
*/
|
||||||
|
var PerformanceEntry: typeof globalThis extends {
|
||||||
|
onmessage: any;
|
||||||
|
PerformanceEntry: infer T;
|
||||||
|
} ? T
|
||||||
|
: typeof _PerformanceEntry;
|
||||||
|
/**
|
||||||
|
* `PerformanceMark` is a global reference for `import { PerformanceMark } from 'node:node:perf_hooks'`
|
||||||
|
* @see https://nodejs.org/docs/latest-v20.x/api/globals.html#performancemark
|
||||||
|
* @since v19.0.0
|
||||||
|
*/
|
||||||
|
var PerformanceMark: typeof globalThis extends {
|
||||||
|
onmessage: any;
|
||||||
|
PerformanceMark: infer T;
|
||||||
|
} ? T
|
||||||
|
: typeof _PerformanceMark;
|
||||||
|
/**
|
||||||
|
* `PerformanceMeasure` is a global reference for `import { PerformanceMeasure } from 'node:node:perf_hooks'`
|
||||||
|
* @see https://nodejs.org/docs/latest-v20.x/api/globals.html#performancemeasure
|
||||||
|
* @since v19.0.0
|
||||||
|
*/
|
||||||
|
var PerformanceMeasure: typeof globalThis extends {
|
||||||
|
onmessage: any;
|
||||||
|
PerformanceMeasure: infer T;
|
||||||
|
} ? T
|
||||||
|
: typeof _PerformanceMeasure;
|
||||||
|
/**
|
||||||
|
* `PerformanceObserver` is a global reference for `import { PerformanceObserver } from 'node:node:perf_hooks'`
|
||||||
|
* @see https://nodejs.org/docs/latest-v20.x/api/globals.html#performanceobserver
|
||||||
|
* @since v19.0.0
|
||||||
|
*/
|
||||||
|
var PerformanceObserver: typeof globalThis extends {
|
||||||
|
onmessage: any;
|
||||||
|
PerformanceObserver: infer T;
|
||||||
|
} ? T
|
||||||
|
: typeof _PerformanceObserver;
|
||||||
|
/**
|
||||||
|
* `PerformanceObserverEntryList` is a global reference for `import { PerformanceObserverEntryList } from 'node:node:perf_hooks'`
|
||||||
|
* @see https://nodejs.org/docs/latest-v20.x/api/globals.html#performanceobserverentrylist
|
||||||
|
* @since v19.0.0
|
||||||
|
*/
|
||||||
|
var PerformanceObserverEntryList: typeof globalThis extends {
|
||||||
|
onmessage: any;
|
||||||
|
PerformanceObserverEntryList: infer T;
|
||||||
|
} ? T
|
||||||
|
: typeof _PerformanceObserverEntryList;
|
||||||
|
/**
|
||||||
|
* `PerformanceResourceTiming` is a global reference for `import { PerformanceResourceTiming } from 'node:node:perf_hooks'`
|
||||||
|
* @see https://nodejs.org/docs/latest-v20.x/api/globals.html#performanceresourcetiming
|
||||||
|
* @since v19.0.0
|
||||||
|
*/
|
||||||
|
var PerformanceResourceTiming: typeof globalThis extends {
|
||||||
|
onmessage: any;
|
||||||
|
PerformanceResourceTiming: infer T;
|
||||||
|
} ? T
|
||||||
|
: typeof _PerformanceResourceTiming;
|
||||||
|
/**
|
||||||
|
* `performance` is a global reference for `import { performance } from 'node:node:perf_hooks'`
|
||||||
|
* @see https://nodejs.org/docs/latest-v20.x/api/globals.html#performance
|
||||||
|
* @since v16.0.0
|
||||||
|
*/
|
||||||
|
var performance: typeof globalThis extends {
|
||||||
|
onmessage: any;
|
||||||
|
performance: infer T;
|
||||||
|
} ? T
|
||||||
|
: typeof _performance;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
declare module "node:perf_hooks" {
|
||||||
|
export * from "perf_hooks";
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user