Typings. (#19)

* Create tslint.json

* Fixed typos, added typings.

* Fixed all JSDocs

package.json

@@ -3,10 +3,11 @@
   "version": "0.3.0",
   "description": "Node.js V8 native fs enhanced with util.promisify and standard extra methods.",
   "main": "src/index.js",
+  "types": "typings/index.d.ts",
   "scripts": {
     "test": "npm run lint & npm run ava",
     "docs": "npx jsdoc -c ./.docstrap.json -R README.md",
-    "lint": "npx eslint src test",
+    "lint": "npx eslint src test && npx tslint --fix 'typings/*.ts'",
     "ava": "npx ava \"test/test.js\" -T 10000"
   },
   "keywords": [

src/nextra/copyFileAtomic.js

@@ -3,21 +3,13 @@ const { copyFile } = require('../fs');
 
 const move = require('./move');
 
-/**
- * @typedef writeOptions
- * @memberof fsn/nextra
- * @property {string} [encoding = 'utf8'] The file encoding
- * @property {integer} [mode = 0o666] The chmod
- * @property {string} [flag = 'w'] The flag
- */
-
 /**
  * @function copyFileAtomic
  * @memberof fsn/nextra
  * @param  {string} source The path to the file you want to copy
  * @param  {string} destination The path to the file destination
  * @param  {writeOptions|string} [options] The write options or the encoding string.
- * @return {type} {description}
+ * @return {Promise<void>} {description}
  */
 module.exports = async function copyFileAtomic(source, destination, options) {
 	const tempPath = tempFile();

src/nextra/createFileCopy.js

@@ -6,15 +6,6 @@ const copyFileAtomic = require('./copyFileAtomic');
 const mkdirs = require('./mkdirs');
 const pathExists = require('./pathExists');
 
-/**
- * Creates an empty file, making all folders required to satisfy the given file path.
- * @function ensureFile
- * @memberof fsn/nextra
- * @param  {string} file Path of the file you want to create
- * @param  {boolean} [atomic = false] Whether the operation should run atomicly
- * @return {Promise<void>}
- */
-
 /**
  * Creates an empty file, making all folders required to satisfy the given file path.
  * @function createFileCopy

src/nextra/createFileCopyAtomic.js

@@ -1,14 +1,5 @@
 const createFileCopy = require('./createFileCopy');
 
-/**
- * Creates an empty file, making all folders required to satisfy the given file path.
- * @function ensureFile
- * @memberof fsn/nextra
- * @param  {string} file Path of the file you want to create
- * @param  {boolean} [atomic = false] Whether the operation should run atomicly
- * @return {Promise<void>}
- */
-
 /**
  * Creates an empty file, making all folders required to satisfy the given file path.
  * @function createFileCopyAtomic

src/nextra/pathExists.js

@@ -4,7 +4,7 @@ const { access } = require('../fs');
  * Checks if a path exists.
  * @function pathExists
  * @memberof fsn/nextra
- * @param {type} path The path to check
+ * @param {string} path The path to check
  * @return {Promise<boolean>}
  */
 module.exports = function pathExists(path) {

src/nextra/readJSON.js

@@ -5,7 +5,7 @@ const { readFile } = require('../fs');
  * @typedef {object} readJSONOptions
  * @memberof fsn/nextra
  * @property {string} [encoding] The file encoding to use while reading
- * @property {type} [reviver] The reviver function to pass to JSON.parse()
+ * @property {Function} [reviver] The reviver function to pass to JSON.parse()
  */
 
 /**

src/nextra/remove.js

@@ -3,7 +3,7 @@ const util = require('../util');
 /**
  * @typedef {object} removeOptions
  * @memberof fsn/nextra
- * @property {integer} [maxBusyTries = 3] The number of times fs-nextra should retry removing a busy file.
+ * @property {number} [maxBusyTries = 3] The number of times fs-nextra should retry removing a busy file.
  */
 
 /**

src/nextra/writeFileAtomic.js

@@ -7,7 +7,7 @@ const move = require('./move');
  * @typedef writeOptions
  * @memberof fsn/nextra
  * @property {string} [encoding = 'utf8'] The file encoding
- * @property {integer} [mode = 0o666] The chmod
+ * @property {number} [mode = 0o666] The chmod
  * @property {string} [flag = 'w'] The flag
  */
 
@@ -17,7 +17,7 @@ const move = require('./move');
  * @param  {string} file The path to the file you want to create
  * @param  {string|Buffer|Uint8Array} data The data to write to file
  * @param  {writeOptions|string} [options] The write options or the encoding string.
- * @return {type} {description}
+ * @return {Promise<void>}
  */
 module.exports = async function writeFileAtomic(file, data, options) {
 	const tempPath = tempFile();

src/nextra/writeJSON.js

@@ -6,9 +6,9 @@ const writeFileAtomic = require('./writeFileAtomic');
  * @typedef {Object} jsonOptions
  * @memberof fsn/nextra
  * @property {Function} [replacer] A JSON.stringify replacer function
- * @property {integer} [spaces = null] The number of spaces to format the json file with
+ * @property {number} [spaces = null] The number of spaces to format the json file with
  * @property {string} [encoding = 'utf8'] The file encoding
- * @property {integer} [mode = 0o666] The chmod
+ * @property {number} [mode = 0o666] The chmod
  * @property {string} [flag = 'w'] The flag
  */
 

tslint.json

@@ -0,0 +1,60 @@
+{
+	"rules": {
+		"no-inferrable-types": [false],
+		"no-unused-expression": true,
+		"no-duplicate-variable": true,
+		"no-shadowed-variable": true,
+		"comment-format": [
+			true, "check-space"
+		],
+		"indent": [
+			true, "tabs"
+		],
+		"curly": false,
+		"class-name": true,
+		"semicolon": [true],
+		"triple-equals": true,
+		"eofline": true,
+		"no-bitwise": false,
+		"no-console": [false],
+		"member-access": [true, "check-accessor", "check-constructor"],
+		"no-consecutive-blank-lines": [true],
+		"no-parameter-properties": true,
+		"one-line": [
+			false
+		],
+		"variable-name": [true, "ban-keywords", "check-format", "allow-leading-underscore"],
+		"interface-name": [true, "always-prefix"],
+		"no-conditional-assignment": true,
+		"use-isnan": true,
+		"no-trailing-whitespace": true,
+		"quotemark": [true, "single", "avoid-escape"],
+		"no-use-before-declare": false,
+		"whitespace": [true,
+			"check-branch",
+			"check-decl",
+			"check-operator",
+			"check-module",
+			"check-separator",
+			"check-type",
+			"check-typecast"
+		],
+		"typedef-whitespace": [
+			true,
+			{
+				"call-signature": "nospace",
+				"index-signature": "nospace",
+				"parameter": "nospace",
+				"property-declaration": "nospace",
+				"variable-declaration": "nospace"
+			},
+			{
+				"call-signature": "onespace",
+				"index-signature": "onespace",
+				"parameter": "onespace",
+				"property-declaration": "onespace",
+				"variable-declaration": "onespace"
+			}
+		]
+	}
+}