JSPM

dom-smart-plan

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q34965F
  • License MIT

Api for getting what type of Dominion Smart Plan day it is

Package Exports

  • dom-smart-plan

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dom-smart-plan) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

dom-smart-plan

Api for getting information about the current Dominion Smart Pricing Plan day

This currently only works for dominion power in Virginia

Installation

npm install dom-smart-plan

Examples

var smartPlan = require('dom-smart-plan');

smartPlan.today().then(console.log)

API

All methods currently return a Promise with an argument of {designation:("A"|"B"|"C"|null)}

today()

Status for today

Returns: Promise

tomorrow()

Status for tomorrow

Returns: Promise

inDays(days)

Gets the status for n number of days away

Parameters

days: String | int, can be negative

Returns: Promise

onDate(date)

Gets the status for based on date

Parameters

date: Date

Returns: Promise