Add code docs formerly in the readme (#5)

* reinstate 2.12.5 and 2.13.0

* lint errors

* adding a missing file

* doc comments

* cleanup

* fix lint errors

* fix lint errors

* fix lint errors

* undo a commit

* undo a commit

* add typedoc build (#6)

* add typedoc build

* add makefile

* exclude test code

* doc comment fixes

* more code doc cleanup

* minor doc update

Author: bwoskow-ld

.ldrelease/config.yml

@@ -11,7 +11,6 @@ template:
 
 documentation:
   githubPages: true
-  title: LaunchDarkly React SDK
 
 sdk:
   displayName: "React"

docs/Makefile

@@ -0,0 +1,28 @@
+
+# This makefile can be run locally (cd docs && LD_RELEASE_VERSION=xxx make) but it will
+# also be run automatically when doing a release via Releaser.
+
+ifeq (,${LD_RELEASE_VERSION})
+TITLE=LaunchDarkly React SDK
+else
+TITLE=LaunchDarkly React SDK (${LD_RELEASE_VERSION})
+endif
+
+html:
+	rm -rf build
+	mkdir -p build/html
+# For unknown reasons, TypeDoc doesn't seem to work reliably in this project when we put our
+# configuration in typedoc.js (as we do in all our other JS projects). Therefore we'll just
+# put all the options on the command line.
+# Also for unknown reasons, TypeDoc does not like us to specify a source path of ./src even
+# though that's what we do in our other projects, so we'll cd to the project root.
+	cd .. && ./node_modules/.bin/typedoc \
+	  --mode file \
+	  --out ./docs/build/html \
+	  --name "${TITLE}" \
+	  --exclude '**/*.test.ts*' \
+	  --excludeExternals \
+	  --externalPattern "**/node_modules/**" \
+	  --readme none
+
+.PHONY: html

package-lock.json

@@ -50,6 +50,7 @@
     "tslint": "^5.13.1",
     "tslint-config-prettier": "^1.18.0",
     "tslint-plugin-prettier": "^2.0.1",
+    "typedoc": "0.14.2",
     "typescript": "^3.3.3333"
   },
   "dependencies": {

package.json

@@ -12,16 +12,28 @@ interface LDContext {
   flags: LDFlagSet;
 
   /**
-   * The LaunchDarkly client's instance interface. This will be be undefined initially until
-   * initialization is complete.
+   * An instance of `LDClient` from the LaunchDarkly JS SDK (`launchdarkly-js-client-sdk`).
+   * This will be be undefined initially until initialization is complete.
    *
    * @see http://docs.launchdarkly.com/docs/js-sdk-reference
    */
   ldClient?: LDClient;
 }
 
+/**
+ * @ignore
+ */
 const context = createContext<LDContext>({ flags: {}, ldClient: undefined });
-const { Provider, Consumer } = context;
+const {
+  /**
+   * @ignore
+   */
+  Provider,
+  /**
+   * @ignore
+   */
+  Consumer,
+} = context;
 
 export { Provider, Consumer, LDContext };
 export default context;

src/context.ts

@@ -2,11 +2,34 @@ import { initialize as ldClientInitialize, LDClient, LDFlagSet, LDOptions, LDUse
 import { defaultReactOptions, LDReactOptions } from './types';
 import { camelCaseKeys } from './utils';
 
+/**
+ * Return type of `initLDClient`.
+ */
 interface AllFlagsLDClient {
+  /**
+   * Contains all flags from LaunchDarkly.
+   */
   flags: LDFlagSet;
+
+  /**
+   * An instance of `LDClient` from the LaunchDarkly JS SDK (`launchdarkly-js-client-sdk`).
+   *
+   * @see http://docs.launchdarkly.com/docs/js-sdk-reference
+   */
   ldClient: LDClient;
 }
 
+/**
+ * Internal function to initialize the `LDClient`.
+ *
+ * @param clientSideID Your project and environment specific client side ID
+ * @param user A LaunchDarkly user object
+ * @param options LaunchDarkly initialization options
+ * @param targetFlags If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
+ *
+ * @see `ProviderConfig` for more details about the parameters
+ * @return An initialized client and flags
+ */
 const initLDClient = async (
   clientSideID: string,
   user: LDUser = { anonymous: true },