docs: update api docs

ccontrols · Jun 25, 2020 · d5bb9bf · d5bb9bf
1 parent 0e19144
commit d5bb9bf
Show file tree

Hide file tree

Showing 6 changed files with 0 additions and 1,890 deletions.
diff --git a/core/config/README.md b/core/config/README.md
@@ -3,12 +3,6 @@
 -   [Overview](#overview)
 -   [Installation](#installation)
 -   [API](#api)
-    -   [ConfigrationResult](#configrationresult)
-    -   [buildConfigFileNames](#buildconfigfilenames)
-    -   [optionsFileNames](#optionsfilenames)
-    -   [extractStories](#extractstories)
-    -   [getConfigurationArg](#getconfigurationarg)
-    -   [loadConfiguration](#loadconfiguration)
 
 # Overview
 
@@ -28,80 +22,4 @@ $ npm install @component-controls/config --save-dev
 
 <!-- START-TSDOC-TYPESCRIPT -->
 
-## ConfigrationResult
-
-_defined in [@component-controls/config/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/config/src/index.ts#L10)_
-
-
-
-### properties
-
-| Name              | Type                                      | Description |
-| ----------------- | ----------------------------------------- | ----------- |
-| `config*`         | [BuildConfiguration](#buildconfiguration) |             |
-| `configPath*`     | string                                    |             |
-| `optionsFilePath` | string                                    |             |
-
-## buildConfigFileNames
-
-_defined in [@component-controls/config/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/config/src/index.ts#L7)_
-
-
-
-## optionsFileNames
-
-_defined in [@component-controls/config/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/config/src/index.ts#L9)_
-
-
-
-## extractStories
-
-find the story files out of a configuration file
-using glob for the regex file search
-
-_defined in [@component-controls/config/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/config/src/index.ts#L74)_
-
-**function** extractStories(`__namedParameters`\*: **config**: [BuildConfiguration](#buildconfiguration)**configPath**: string): string\[] | undefined;
-
-### parameters
-
-| Name                 | Type                                                                        | Description |
-| -------------------- | --------------------------------------------------------------------------- | ----------- |
-| `__namedParameters*` | **config**: [BuildConfiguration](#buildconfiguration)**configPath**: string |             |
-| `returns`            | string\[] \| undefined                                                      |             |
-
-## getConfigurationArg
-
-return the configration folder from command-line parameters
-command line accepts -c/ -config parameter for config path
-the config file is assumed named main.js/main.ts
-
-_defined in [@component-controls/config/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/config/src/index.ts#L21)_
-
-**function** getConfigurationArg(`args`\*: string\[]): string | undefined;
-
-### parameters
-
-| Name      | Type                | Description |
-| --------- | ------------------- | ----------- |
-| `args*`   | string\[]           |             |
-| `returns` | string \| undefined |             |
-
-## loadConfiguration
-
- given a base project folder and a configuration folder, returns the configuration file
-
-_defined in [@component-controls/config/src/index.ts](https://github.com/ccontrols/component-controls/tree/master/core/config/src/index.ts#L42)_
-
-**function** loadConfiguration(`baseFolder`\*: string, `configFolder`: string, `args`: string\[]): [ConfigrationResult](#configrationresult) | undefined;
-
-### parameters
-
-| Name           | Type                                                   | Description                                    |
-| -------------- | ------------------------------------------------------ | ---------------------------------------------- |
-| `baseFolder*`  | string                                                 | project folder to start the search with        |
-| `configFolder` | string                                                 | folder where the configuration file is located |
-| `args`         | string\[]                                              | optional arguments                             |
-| `returns`      | [ConfigrationResult](#configrationresult) \| undefined |                                                |
-
 <!-- END-TSDOC-TYPESCRIPT -->