-
-
Notifications
You must be signed in to change notification settings - Fork 23
feat(api): basic api generation #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
avivkeller
wants to merge
5
commits into
main
Choose a base branch
from
doc-gen
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| node_modules | ||
| *.generated.json |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # webpack Project Governance | ||
|
|
||
| The webpack project (and organization) follows the webpack's governance model defined within [the webpack governance repository](https://github.com/webpack/governance/blob/main/README.md). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # Webpack Core Working Group | ||
|
|
||
| This document outlines the webpack core working group. | ||
|
|
||
| --- | ||
|
|
||
| ## Working Group Name | ||
|
|
||
| Webpack Core Working Group | ||
|
|
||
| ## Purpose and Responsibilities | ||
|
|
||
| The purpose of this working group is to facilitate, implement and fix problems and features within the core of webpack. This core includes tasking such as bugfixes, feature implementation and in general maintaining the main logic of webpack. | ||
|
|
||
| Each member of the working group is required to adhere to the [governance model of webpack](https://github.com/webpack/governance). In addition to having responsibility of the main part of webpack, the working group will manage other parts of the webpack organization repositories in such way they see fit. | ||
|
|
||
| ## Goals & Objectives | ||
|
|
||
| - Develop features within the webpack organization and core areas. | ||
| - Fix bugs within webpack organization and core areas. | ||
| - Maintain and steer webpack in general together with the Technical Steering Committee. | ||
| - Ensure performance and code coverage is sustained and top-notch. | ||
|
|
||
| ## Members | ||
|
|
||
| - [snitin315](https://github.com/snitin315) - | ||
| **Nitin Kumar** <<snitin315@gmail.com>> (he/him) | ||
| - [thelarkinn](https://github.com/thelarkinn) - | ||
| **Sean Larkin** <<selarkin@microsoft.com>> (he/him) | ||
| - [jhnns](https://github.com/jhnns) - | ||
| **Johannes Ewald** <<mail@johannesewald.de>> | ||
| - [sokra](https://github.com/sokra) - | ||
| **Tobias Koppers** <<jackworks@protonmail.co>> | ||
| - [spacek33z](https://github.com/spacek33z) - | ||
| **Kees Kluskens** <<kees@webduck.nl>> | ||
avivkeller marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Communication | ||
|
|
||
| Meetings are hosted on an as-needed basis and private discussions are held in the #core-wg channel. For public feedback and communication, please use an appropriate channel within the webpack discord (e.g `#development-general`). | ||
|
|
||
| ## Resources | ||
|
|
||
| - https://github.com/webpack | ||
| - https://github.com/webpack/governance | ||
|
|
||
| ## Reporting & Updates | ||
|
|
||
| - The working group can choose to involve the webpack TSC for feedback and updates, but has full autonomy of making changes to any codebase within webpack. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,306 @@ | ||
| --- | ||
| title: AsyncDependenciesBlock | ||
| --- | ||
|
|
||
| [webpack](../globals) / AsyncDependenciesBlock | ||
|
|
||
| # Class: AsyncDependenciesBlock | ||
|
|
||
| Defined in: [webpack/types.d.ts:498](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L498) | ||
|
|
||
| ## Extends | ||
|
|
||
| * `DependenciesBlock` | ||
|
|
||
| ## Constructors | ||
|
|
||
| ### Constructor | ||
|
|
||
| > **new AsyncDependenciesBlock**(`groupOptions`, `loc?`, `request?`): `AsyncDependenciesBlock` | ||
|
|
||
| Defined in: [webpack/types.d.ts:499](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L499) | ||
|
|
||
| #### Parameters | ||
|
|
||
| ##### groupOptions | ||
|
|
||
| `string` | `GroupOptionsAsyncDependenciesBlock` | ||
|
|
||
| ##### loc? | ||
|
|
||
| `SyntheticDependencyLocation` | `RealDependencyLocation` | ||
|
|
||
| ##### request? | ||
|
|
||
| `string` | ||
|
|
||
| #### Returns | ||
|
|
||
| `AsyncDependenciesBlock` | ||
|
|
||
| #### Overrides | ||
|
|
||
| `DependenciesBlock.constructor` | ||
|
|
||
| ## Properties | ||
|
|
||
| ### blocks | ||
|
|
||
| > **blocks**: `AsyncDependenciesBlock`\[] | ||
|
|
||
| Defined in: [webpack/types.d.ts:4110](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4110) | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.blocks` | ||
|
|
||
| *** | ||
|
|
||
| ### chunkName? | ||
|
|
||
| > `optional` **chunkName**: `string` | ||
|
|
||
| Defined in: [webpack/types.d.ts:507](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L507) | ||
|
|
||
| *** | ||
|
|
||
| ### dependencies | ||
|
|
||
| > **dependencies**: [`Dependency`](Dependency.md)\[] | ||
|
|
||
| Defined in: [webpack/types.d.ts:4109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4109) | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.dependencies` | ||
|
|
||
| *** | ||
|
|
||
| ### groupOptions | ||
|
|
||
| > **groupOptions**: `GroupOptionsAsyncDependenciesBlock` | ||
|
|
||
| Defined in: [webpack/types.d.ts:504](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L504) | ||
|
|
||
| *** | ||
|
|
||
| ### loc? | ||
|
|
||
| > `optional` **loc**: `SyntheticDependencyLocation` | `RealDependencyLocation` | ||
|
|
||
| Defined in: [webpack/types.d.ts:505](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L505) | ||
|
|
||
| *** | ||
|
|
||
| ### module | ||
|
|
||
| > **module**: `any` | ||
|
|
||
| Defined in: [webpack/types.d.ts:509](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L509) | ||
|
|
||
| *** | ||
|
|
||
| ### parent? | ||
|
|
||
| > `optional` **parent**: `DependenciesBlock` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4111](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4111) | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.parent` | ||
|
|
||
| *** | ||
|
|
||
| ### request? | ||
|
|
||
| > `optional` **request**: `string` | ||
|
|
||
| Defined in: [webpack/types.d.ts:506](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L506) | ||
|
|
||
| ## Accessors | ||
|
|
||
| ### circular | ||
|
|
||
| #### Get Signature | ||
|
|
||
| > **get** **circular**(): `boolean` | ||
|
|
||
| Defined in: [webpack/types.d.ts:508](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L508) | ||
|
|
||
| ##### Returns | ||
|
|
||
| `boolean` | ||
|
|
||
| ## Methods | ||
|
|
||
| ### addBlock() | ||
|
|
||
| > **addBlock**(`block`): `void` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4118](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4118) | ||
|
|
||
| Adds a DependencyBlock to DependencyBlock relationship. | ||
| This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) | ||
|
|
||
| #### Parameters | ||
|
|
||
| ##### block | ||
|
|
||
| `AsyncDependenciesBlock` | ||
|
|
||
| #### Returns | ||
|
|
||
| `void` | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.addBlock` | ||
|
|
||
| *** | ||
|
|
||
| ### addDependency() | ||
|
|
||
| > **addDependency**(`dependency`): `void` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4119](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4119) | ||
|
|
||
| #### Parameters | ||
|
|
||
| ##### dependency | ||
|
|
||
| [`Dependency`](Dependency.md) | ||
|
|
||
| #### Returns | ||
|
|
||
| `void` | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.addDependency` | ||
|
|
||
| *** | ||
|
|
||
| ### clearDependenciesAndBlocks() | ||
|
|
||
| > **clearDependenciesAndBlocks**(): `void` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4125) | ||
|
|
||
| Removes all dependencies and blocks | ||
|
|
||
| #### Returns | ||
|
|
||
| `void` | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.clearDependenciesAndBlocks` | ||
|
|
||
| *** | ||
|
|
||
| ### deserialize() | ||
|
|
||
| > **deserialize**(`__namedParameters`): `void` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4128](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4128) | ||
|
|
||
| #### Parameters | ||
|
|
||
| ##### \_\_namedParameters | ||
|
|
||
| [`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext) | ||
|
|
||
| #### Returns | ||
|
|
||
| `void` | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.deserialize` | ||
|
|
||
| *** | ||
|
|
||
| ### getRootBlock() | ||
|
|
||
| > **getRootBlock**(): `DependenciesBlock` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4112](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4112) | ||
|
|
||
| #### Returns | ||
|
|
||
| `DependenciesBlock` | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.getRootBlock` | ||
|
|
||
| *** | ||
|
|
||
| ### removeDependency() | ||
|
|
||
| > **removeDependency**(`dependency`): `void` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4120](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4120) | ||
|
|
||
| #### Parameters | ||
|
|
||
| ##### dependency | ||
|
|
||
| [`Dependency`](Dependency.md) | ||
|
|
||
| #### Returns | ||
|
|
||
| `void` | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.removeDependency` | ||
|
|
||
| *** | ||
|
|
||
| ### serialize() | ||
|
|
||
| > **serialize**(`__namedParameters`): `void` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4127](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4127) | ||
|
|
||
| #### Parameters | ||
|
|
||
| ##### \_\_namedParameters | ||
|
|
||
| [`ObjectSerializerContext`](../interfaces/ObjectSerializerContext) | ||
|
|
||
| #### Returns | ||
|
|
||
| `void` | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.serialize` | ||
|
|
||
| *** | ||
|
|
||
| ### updateHash() | ||
|
|
||
| > **updateHash**(`hash`, `context`): `void` | ||
|
|
||
| Defined in: [webpack/types.d.ts:4126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4126) | ||
|
|
||
| #### Parameters | ||
|
|
||
| ##### hash | ||
|
|
||
| `Hash` | ||
|
|
||
| ##### context | ||
|
|
||
| `UpdateHashContextDependency` | ||
|
|
||
| #### Returns | ||
|
|
||
| `void` | ||
|
|
||
| #### Inherited from | ||
|
|
||
| `DependenciesBlock.updateHash` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.