Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "datasets/img-nagasaki-boats/docs/types/index.d"

Index

Functions

Functions

image

  • Returns an image of boats in a river in Nagasaki.

    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 Buffer

    image

    Example

    var img = image();
    // returns <Buffer>