Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@netlify/types

netlify530.6kMIT2.0.3TypeScript support: included

TypeScript definitions for the Netlify platform

readme

@netlify/types

npm version

TypeScript types for Netlify platform primitives.

Installation

npm install @netlify/types

Requirements

  • Node.js 16.0.0 and above

Usage

This package provides TypeScript type definitions for various Netlify platform primitives. Import the types you need in your TypeScript code:

import type { Context } from '@netlify/types'
import type { NetlifyGlobal } from '@netlify/types'

Types

The package includes TypeScript definitions for:

  • Context: Type definitions for Netlify's context object
  • NetlifyGlobal: Type definitions for Netlify's global variables

Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.