JSPM

spiralloop

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 44
  • Score
    100M100P100Q62780F
  • License ISC

Create for loops that spiral from the center or a given point

Package Exports

  • spiralloop

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (spiralloop) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SpiralLoop

Ever wanted to do a for loop starting from the center instead of a corner? Now you can!

Install

npm install spiralloop

Usage

spiral(Lengths, [Center], Function)

Lengths

An array of the lengths of your loop, such as [4, 4] or [5, 3, 7]. Handles array lengths as long as you'd like.

Center (Optional)

The default center is in the middle (1.5, 1.5 of a 3x3) but feel free to change this up.

Function

A function that will give paramaters of the current value. For example:

function(x, y, z) { }

If you return true in this function, it will act as a "break".

Example

var spiral = require('spiralloop');

spiral([3, 3], function(x, y) {
    console.log(x + ', ' + y);
});