https://github.com/jawg/types.ts

Shared TypeScript definitions for Jawg Maps projects
https://github.com/jawg/types.ts

geocoder geocoder-library jawg pelias typescript typescript-definitions

Last synced: 4 months ago
JSON representation

Shared TypeScript definitions for Jawg Maps projects

• Host: GitHub
• URL: https://github.com/jawg/types.ts
• Owner: jawg
• License: mit
• Created: 2021-07-05T08:52:31.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-01-02T15:08:01.000Z (over 1 year ago)
• Last Synced: 2025-10-23T09:39:38.204Z (8 months ago)
• Topics: geocoder, geocoder-library, jawg, pelias, typescript, typescript-definitions
• Language: JavaScript
• Homepage: https://jawg.github.io/types.ts
• Size: 405 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# types.ts

Shared TypeScript definitions for Jawg Maps projects

[![npm version](https://img.shields.io/npm/v/@jawg/types.svg)](https://www.npmjs.com/package/@jawg/types)

[![Run lint and test](https://github.com/jawg/types.ts/actions/workflows/build.yml/badge.svg)](https://github.com/jawg/types.ts/actions/workflows/build.yml)

[![Publish GitHub Pages](https://github.com/jawg/types.ts/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/jawg/types.ts/actions/workflows/gh-pages.yml)

[![Release NPM Package](https://github.com/jawg/types.ts/actions/workflows/release.yml/badge.svg)](https://github.com/jawg/types.ts/actions/workflows/release.yml)

[![License](https://img.shields.io/github/license/jawg/types.ts)](https://github.com/jawg/types.ts/blob/main/README.md)

## Usage

See all exported types at https://jawg.github.io/types.ts

## Example

Perfect usage in [@jawg/js-loader](https://github.com/jawg/js-loader) [index.d.ts](https://github.com/jawg/js-loader/blob/main/index.d.ts)

```typescript

import { JawgPlaces } from '@jawg/types';

interface Options {

  accessToken: string;

}

export default class JawgJSLoader {

  constructor(options: Options);

  loadJawgPlaces(version?: string): Promise;

}

```