Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "datasets/us-states-capitals/docs/types/index.d"

Index

Functions

Functions

Export assignment capitals

  • capitals(): Array<string>
  • Returns a list of US state capitals in alphabetical order according to state name.

    Notes

    • This function synchronously reads data from disk for each invocation. Such behavior is intentional and so is the avoidance of require. We assume that invocations are infrequent, and we want to avoid the require cache. This means that we allow data to be garbage collected and a user is responsible for explicitly caching data.
    throws

    unable to read data

    Returns Array < string >

    capitals

    Example

    var data = capitals();
    // returns [ 'Montgomery', 'Juneau', 'Phoenix', 'Little Rock', ... ]