Git Product home page Git Product logo

location-tr.js's Introduction

@turistikrota/location-tr

npm version npm license npm downloads

@turistikrota/location-tr was developed by Turistikrota Tech for use in shared websites.

@turistikrota/location-tr is a TypeScript package designed to provide functionality for location-based operations in Turkey. It now includes an expanded set of features, such as finding the nearest districts, district names, and city names, as well as fetching a sorted list of cities and districts.

Installation

npm install @turistikrota/location-tr

Usage

import {
  Coordinates,
  City,
  District,
  findNearestDistrict,
  findNearestDistrictNames,
  findNearestCityNames,
  getCities,
  getDistricts,
  useCities,
} from '@turistikrota/location-tr';

// Example coordinates
const coordinates: Coordinates = [latitude, longitude];

// Find the nearest district
const nearestDistrict: District | null = findNearestDistrict(coordinates);

// Find the nearest district names
const nearestDistrictNames: string[] = findNearestDistrictNames(coordinates, 5);

// Find the nearest city names
const nearestCityNames: string[] = findNearestCityNames(coordinates, 3);

// Get a sorted list of cities
const sortedCities: City[] = getCities();

// Get a sorted list of districts
const sortedDistricts: District[] = getDistricts();

// Use filtered cities
const filteredCities: City[] = useCities('Istanbul');

Functions

findNearestDistrict(coordinates: Coordinates): District | null

Finds the nearest district based on the given coordinates.

findNearestDistrictNames(coordinates: Coordinates, count: number): string[]

Returns an array of the nearest district names based on the given coordinates and count.

findNearestCityNames(coordinates: Coordinates, count: number): string[]

Returns an array of the nearest city names based on the given coordinates and count.

getCities(): City[]

Returns a sorted list of cities.

getDistricts(): District[]

Returns a sorted list of districts.

useCities(filter: string | null): City[]

Returns a list of cities, optionally filtered by the provided string.

How It Works

The package uses the Haversine formula to calculate distances between geographical coordinates. It also includes additional functionality for retrieving and filtering city data.

License

This project is licensed under the Apache License.

Feel free to contribute, open issues, or provide feedback. Happy coding!

location-tr.js's People

Contributors

9ssi7 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.