@types/raf

What is @types/raf?

@types/raf is a TypeScript type definition package for the 'raf' library, which provides a polyfill for requestAnimationFrame. This package allows TypeScript developers to use the 'raf' library with type safety.

What are @types/raf's main functionalities?

Polyfill for requestAnimationFrame

This feature provides a polyfill for the requestAnimationFrame function, allowing you to schedule a callback to be called during the next repaint cycle. The code sample demonstrates how to import the 'raf' function and use it to log the timestamp of the animation frame.

import raf from 'raf';

raf((timestamp) => {
  console.log(`Animation frame at ${timestamp}`);
});

Cancel animation frame

This feature allows you to cancel a scheduled animation frame callback. The code sample shows how to schedule an animation frame and then cancel it using the 'raf.cancel' method.

import raf from 'raf';

const id = raf((timestamp) => {
  console.log(`Animation frame at ${timestamp}`);
});

raf.cancel(id);

Other packages similar to @types/raf

requestanimationframe

The 'requestanimationframe' package provides a polyfill for requestAnimationFrame similar to 'raf'. It also ensures compatibility across different browsers. Compared to '@types/raf', it does not include TypeScript type definitions out of the box.

raf-schd

The 'raf-schd' package is a scheduler for requestAnimationFrame, which helps in debouncing and throttling animations. It provides more advanced scheduling capabilities compared to 'raf', but like 'requestanimationframe', it does not include TypeScript type definitions by default.

README

Installation

npm install --save @types/raf

Summary

This package contains type definitions for raf (https://github.com/chrisdickinson/raf#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/raf.

index.d.ts

declare const raf: {
    (callback: (timestamp: number) => void): number;
    cancel: (handle: number) => void;
    polyfill: (globalObject?: any) => void;
};

export = raf;

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by Ben Lorantfy.