Improve TypeScript definition

Author: sindresorhus

.gitattributes

@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf

.travis.yml

@@ -1,3 +1,5 @@
 language: node_js
 node_js:
+  - '12'
+  - '10'
   - '8'

index.d.ts

@@ -1,35 +1,68 @@
-import { Container } from "unstated";
+import {Container} from 'unstated';
 
+/**
+When enabled, it exposes a global object `UNSTATED` which you can use in DevTools to explore the containers and their state.
+
+In the root of your app, import `unstated-debug`:
+
+@example
+```
+import React from 'react';
+import {render} from 'react-dom';
+import {Provider} from 'unstated';
+import UNSTATED from 'unstated-debug';
+import App from './components/App';
+
+UNSTATED.logStateChanges = false;
+
+render(
+	<Provider>
+		<App/>
+	</Provider>,
+	document.querySelector('#root')
+);
+```
+*/
 declare const UNSTATED: {
 	/**
-	An object containing the project's containers.
+	Whether the debugger should be enabled or not.
+
+	@default true
 	*/
-	containers: {
-		[containerName: string]: Container<{ [stateName: string]: unknown }>;
-	};
+	isEnabled: boolean;
 
 	/**
-	Whether the debugger should be enabled or not.
+	Whether state changes should be logged to the console.
+
+	@default true
 	*/
-	isEnabled: boolean;
+	logStateChanges: boolean;
 
 	/**
-	Function that logs out the current state.
+	Whether logs should be collapsed.
+
+	@default false
 	*/
-	logState: () => void;
+	isCollapsed: boolean;
 
 	/**
-	Boolean value that represents whether state changes should be logged to the
-	console.
+	Your containers.
 	*/
-	logStateChanges: boolean;
+	containers: {
+		[containerName: string]: Container<{[stateName: string]: unknown}>;
+	};
 
 	/**
-	An object containing all of the state values.
+	All of the state values.
 	*/
 	states: {
-		[containerName: string]: { [stateName: string]: unknown };
+		[containerName: string]: {[stateName: string]: unknown};
 	};
+
+	/**
+	Logs the current state of your containers.
+	*/
+	logState: () => void;
 };
 
 export default UNSTATED;

index.test-d.ts

@@ -1,17 +1,17 @@
-import { expectType } from "tsd-check";
-import UNSTATED from "./index";
-import { Container } from "unstated";
+import {expectType} from 'tsd';
+import {Container} from 'unstated';
+import UNSTATED from '.';
 
 expectType<boolean>(UNSTATED.isEnabled);
 expectType<boolean>(UNSTATED.logStateChanges);
 
 expectType<{
-	[containerName: string]: Container<{ [stateName: string]: unknown }>;
+	[containerName: string]: Container<{[stateName: string]: unknown}>;
 }>(UNSTATED.containers);
 
 expectType<() => void>(UNSTATED.logState);
 expectType<void>(UNSTATED.logState());
 
-expectType<{ [containerName: string]: { [stateName: string]: unknown } }>(
+expectType<{[containerName: string]: {[stateName: string]: unknown }}>(
 	UNSTATED.states
 );

package.json

@@ -13,7 +13,7 @@
 		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -36,12 +36,13 @@
 		"deep-object-diff": "^1.1.0"
 	},
 	"devDependencies": {
-		"ava": "*",
+		"@types/react": "^16.9.4",
+		"ava": "^2.4.0",
 		"browser-env": "^3.2.5",
 		"react": "^16.3.0",
-		"tsd-check": "^0.6.0",
+		"tsd": "^0.9.0",
 		"unstated": "^2.0.2",
-		"xo": "*"
+		"xo": "^0.25.0"
 	},
 	"peerDependencies": {
 		"unstated": "^2.0.2"
@@ -50,9 +51,6 @@
 		"envs": [
 			"node",
 			"browser"
-		],
-		"ignores": [
-			"*.ts"
 		]
 	},
 	"ava": {

readme.md

@@ -45,7 +45,7 @@ The object contains the following properties:
 
 - `isEnabled` - Same as the below option, but you can change it after init.
 - `logStateChanges` - Same as the below option, but you can change it after init.
-- `isCollapsed` - Collapse logs by default.
+- `isCollapsed` - Collapse logs. (Default: false)
 - `containers` - Your containers.
 - `states` - The state objects of your containers.
 - `logState()` - Logs the current state of your containers.
@@ -72,8 +72,3 @@ Default: `true`
 Logs a diff for each state change to the containers. This gives you a live insight into state changes in your app.
 
 <img src="screenshot-diff.png" width="400">
-
-
-## License
-
-MIT © [Sindre Sorhus](https://sindresorhus.com)