https://github.com/pirxpilot/geolocation
Flex API for HTML5 geolocation.
https://github.com/pirxpilot/geolocation
Last synced: 5 months ago
JSON representation
Flex API for HTML5 geolocation.
- Host: GitHub
- URL: https://github.com/pirxpilot/geolocation
- Owner: pirxpilot
- Created: 2014-05-04T11:54:29.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2025-06-05T02:06:54.000Z (about 1 year ago)
- Last Synced: 2025-10-25T05:41:24.527Z (9 months ago)
- Language: HTML
- Homepage: https://pirxpilot.github.io/geolocation
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
README
[![NPM version][npm-image]][npm-url]
[![Build Status][build-image]][build-url]
[![Dependency Status][deps-image]][deps-url]
# geolocation
Flex API for HTML5 geolocation.
## Installation
Install with [npm(1)](https://npmjs.com):
$ npm install -S html5-geolocation
Live demo is [here](https://pirxpilot.github.io/geolocation/).
## API
### get
Determine current device location
```javascript
var geo = require('geolocation')();
geo.get(function(err, position) {
if (!err) {
console.log('Position is:', position);
} else {
console.log('Position unknown:', err.message);
}
});
```
### watch
Watch current device location and periodically emit position event.
```javascript
var geo = require('geolocation')();
geo
.on('position', function(position) {
console.log('Position is:', position);
})
.on('error', function(err) {
console.log('Position unknown:', err.message);
})
.maxAge(45 * 1000)
.timeout(30 * 1000)
.highAccuracy(true)
.watch();
```
### clear
Clears any watch in progress. Safe to call if watch is not in progress.
### Option functions
- `timeout` - maximum time to wait for location (default: 30s)
- `maxAge` - maximum age of location - (default: 60s)
- `highAccuracy` - use GPS if available (default: true)
## Events
- `position` - a new position is obtained when watching
- `error` - emitted when watching and there are problems with obtaining a new position
## License
The MIT License (MIT)
Copyright (c) 2014 [Damian Krzeminski](https://pirxpilot.me)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
[npm-image]: https://img.shields.io/npm/v/html5-geolocation
[npm-url]: https://npmjs.org/package/html5-geolocation
[build-url]: https://github.com/pirxpilot/geolocation/actions/workflows/check.yaml
[build-image]: https://img.shields.io/github/actions/workflow/status/pirxpilot/geolocation/check.yaml?branch=main
[deps-image]: https://img.shields.io/librariesio/release/npm/html5-geolocation
[deps-url]: https://libraries.io/npm/html5-geolocation