spring

View Source

Summary

Creates a spring iterator from a named preset.

Signature

function spring(
  preset: SpringPreset,
  overrides: Omit<SpringOptions, "bounce">,
): SpringIterator;

function spring(options: SpringOptions): SpringIterator;

Params

options

Spring parameters.

preset

Preset spring profile to start from.

overrides

Optional preset overrides.

Returns

A spring iterator.