Merge pull request #50 from fabianishere/feature/typescript-definitions

Add type definitions for TypeScript

Author: ctrlplusb

index.d.ts

@@ -0,0 +1,48 @@
+import * as React from 'react';
+
+/**
+ * The configuration for an asynchronous component.
+ */
+export interface Configuration<P> {
+	resolve: () => Promise<React.Component<P>>;
+	LoadingComponent?: (props: P) => JSX.Element;
+	ErrorComponent?: (props: P & { error: Error }) => JSX.Element;
+	name?: string;
+	autoResolveES2015Default?: boolean;
+	env?: 'node' | 'browser';
+	serverMode?: 'resolve' | 'defer' | 'boundary';
+}
+
+/**
+ * A wrapper to provide the asynchronous component resolving in a React tree.
+ */
+export class AsyncComponentProvider extends React.Component<ProviderProps> {}
+
+/**
+ * The properties that the {@link AsyncComponentProvider} accepts.
+ */
+export interface ProviderProps {
+	children: JSX.Element[] | JSX.Element;
+	asyncContext?: Context;
+	rehydrateState?: object;
+}
+
+/**
+ * This interface defines the asynchronous context uses for the asynchronous resolving
+ * of components.
+ */
+export interface Context {
+	getState: () => object;
+}
+
+/**
+ * Convert the given component to a an asynchronous component.
+ *
+ * @param config The configuration to use for the asynchronous component.
+ */
+export function asyncComponent<T extends React.Component<P>, P>(config: Configuration<P>): React.ComponentClass<P>;
+
+/**
+ * Create a context for the asynchronous component resolving module.
+ */
+export function createAsyncContext(): Context;

package.json

@@ -10,6 +10,7 @@
     "umd",
     "commonjs"
   ],
+  "typings": "./index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/ctrlplusb/react-async-component.git"