@stdlib/datasets-ssa-us-births-2000-2014/docs/types/index.d.ts

US birth data from 2000 to 2014, as provided by the Social Security Administration.

/*
* @license Apache-2.0
*
* Copyright (c) 2020 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/**
* Data point.
*/
interface Observation {
	/**
	* Year.
	*/
	year: number;

	/**
	* Month, where January is denoted by `1`.
	*/
	month: number;

	/**
	* Day number of the month.
	*/
	date_of_month: number;

	/**
	* Day of week, where Monday is `1` and Sunday is `7`.
	*/
	day_of_week: number;

	/**
	* Number of births.
	*/
	births: number;
}

/**
* Returns US birth data from 2000 to 2014, as provided by the Social Security Administration.
*
* ## 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 birth data
*
* @example
* var data = dataset();
* // returns [ {...}, ... ]
*/
declare function dataset(): Array<Observation>;


// EXPORTS //

export = dataset;