External module "datasets/minard-napoleons-march/docs/types/index.d"

Export assignment minard

• minard(options?: Options): Object | Array<Object>

• Returns datasets for Charles Joseph Minard's cartographic depiction of Napoleon's Russian campaign of 1812.

  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

  throws

  must provide valid options

  throws

  must provide a recognized dataset name

  Parameters

  • Optional options: Options

    options object

  Returns Object | Array < Object >

  dataset(s)

  Example

  var data = minard();
  // returns <Object>

  Example

  var data = minard({
      'data': 'army'
  });
  // returns <ObjectArray>