Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.48 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.48 KB

aws-region-utils

aws-region-utils is a utility library for working with AWS regions. It provides functions to calculate distances, sort regions by proximity, and more. This package is designed to help developers easily work with AWS region data in geospatial contexts.

Demo playground - https://pritamrungta.github.io/aws-region-utils

Features

  • Sort AWS Regions by Distance: Calculate and sort AWS regions based on their distance from the user's current GeoLocation (needs user consent for location access).
  • Extensible and Modular: More utility functions will be added in future updates.
  • TypeScript Support: Fully typed with TypeScript for better developer experience and safety.

Installation

Install the package via npm:

npm install aws-region-utils

Usage

Get all AWS Regions

import { awsRegions } from 'aws-region-utils';

const regions = awsRegions();
console.log(regions);

Sorting AWS Regions by Distance

You can use the awsRegionsByDistance function to sort AWS regions by their distance from the user's location:

import { awsRegionsByDistance } from 'aws-region-utils';

awsRegionsByDistance()
    .then((regions) => {
        console.log(regions);
    })
    .catch((error) => {
        console.error(error);
    });

More Features Coming Soon!

All contributions are welcome.