npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@warriorjs/geography

v0.7.0

Published

WarriorJS directioning

Downloads

17

Readme

@warriorjs/geography

WarriorJS directioning.

Install

npm install @warriorjs/geography

Usage

import { FORWARD, getAbsoluteDirection } from '@warriorjs/geography');

Top Level Exports

All methods in the API Reference below, plus the following constants:

NORTH (string)

A constant representing absolute direction north.

EAST (string)

A constant representing absolute direction east.

SOUTH (string)

A constant representing absolute direction south.

WEST (string)

A constant representing absolute direction west.

ABSOLUTE_DIRECTIONS (string[])

The absolute directions in clockwise order.

FORWARD (string)

A constant representing relative direction forward.

RIGHT (string)

A constant representing relative direction right.

BACKWARD (string)

A constant representing relative direction backward.

LEFT (string)

A constant representing relative direction left.

RELATIVE_DIRECTIONS (string[])

The relative directions in clockwise order.

API Reference

getAbsoluteDirection(direction: string, referenceDirection: string)

Returns the absolute direction for a given direction, with reference to another direction (reference direction).

getAbsoluteOffset(relativeOffset: number[], referenceDirection: string)

Returns the absolute offset for a given relative offset with reference to a given direction (reference direction).

getDirectionOfLocation(location: number[], referenceLocation: number[])

Returns the direction of a location from another location (reference location).

getDistanceOfLocation(location: number[], referenceLocation: number[])

Returns the Manhattan distance of a location from another location (reference location).

getRelativeDirection(direction: string, referenceDirection: string)

Returns the relative direction for a given direction, with reference to a another direction (reference direction).

getRelativeOffset(location: number[], referenceLocation: number[], referenceDirection: string)

Returns the relative offset for a given location, with reference to another location (reference location) and direction (reference direction).

rotateRelativeOffset(offset: number[], direction: string)

Rotates the given relative offset in the given direction.

translateLocation(location: number[], offset: number[])

Translates the given location by a given offset.

verifyAbsoluteDirection(direction: string)

Checks if the given direction is a valid absolute direction.

verifyRelativeDirection(direction: string)

Checks if the given direction is a valid relative direction.