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

@dotdev/locations

v0.3.0

Published

Front end store locator api wrapper

Downloads

9

Readme

Store location

import Locations from '@dotdev/locations'

const locationsJS = new Locations({options})
Options - optional - object

You are able to provide options to locations that will assist with testing. The options are not intended to be used for production.

Using the following settings will send all requests to the Alice mcCall dev environment.

const locationsJS = new StoreLocations({
  url: 'https://connector-dev.alicemccall.io/api/apps',
  params: '?shop=alice-mccall-stage.myshopify.com',
  storeKey: 'pickup_store_id',
  locationsUrl: '/location-lookup',
  inventoryUrl: '/inventory-lookup/locations'
})

The default url is '/apps/connector' and there are no default parameters

Methods

locationLookup({config})

Description

Find locations near to specified coordinates.

{config} - required - object

data - required - object

It is required that you send the location to the locationLookup

data: {
  coordinates: {
    latitude: lat,
    longitude: long
  }
}
success - optional - function

A callback function for once the stores have been located

success: function (response) {
  const json = JSON.parse(response)
}
error - optional - function

A callback function fired if the API returns an error

error: function (err) {
  console.error(err)
}

Example

const request = {
  data: {
    coordinates: {
      latitude: lat,
      longitude: long
    }
  },
  success: function (response) {
    const json = JSON.parse(response)
  }.bind(this)
}
locationsJS.locationLookup(request)

inventoryLocationsByIds({config})

Description

Find locations that stock a specified list of variants by id.

{config} - required - object

data - required - object

It is required that you send the location and an array of variant ids to the locationLookup

data: {
  coordinates: {
    latitude: lat,
    longitude: long
  },
  variants: [16326964609081, 12445435324234, 32452344534553]
}
success - optional - function

A callback function for once the stores have been located

success: function (response) {
  const json = JSON.parse(response)
}
error - optional - function

A callback function fired if the API returns an error

error: function (err) {
  console.error(err)
}

Example

const request = {
  data: {
    coordinates: {
      latitude: lat,
      longitude: long
    },
    variants: [16326964609081]
  },
  error: function locationError (response) {
    console.log(response)
  },
  success: function (response) {
    const json = JSON.parse(response)
  }.bind(this)
}
this.storeLocations.inventoryLocationsByIds(request)

setClickAndCollectStore({config})

{config} - required - object

id - required - integer

The id of the localtion that you wish to us for click and collect.

  id: 6
success - optional - function

A callback function for once the stores have been located

success: function (response) {
  const json = JSON.parse(response)
}
error - optional - function

A callback function fired if the API returns an error

error: function (err) {
  console.error(err)
}

Example

locationsJS.setClickAndCollectStore({ id: id });