yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-10-30 17:37:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): add container link to Strapi class

Browse Source
This commit is contained in:
nathan-pichon 2023-02-08 15:11:30 +01:00
parent 59bc546ec7
commit 05c0c1cad7
No known key found for this signature in database
2 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/docs/api/Strapi.mdx
View File

@ -48,3 +48,6 @@ const strapiInstance = new Strapi();
### `strapi.container` ### `strapi.container`
This is where all registries are stored. This is where all registries are stored.
See [Container](./container).

43
docs/docs/api/container.mdx
View File

@ -38,6 +38,26 @@ container.register('config', {
const dbConfig = container.get('config').get('database'); const dbConfig = container.get('config').get('database');
``` ```
### `container.register(name, resolver)`
- `name`: <Type>String</Type> UID of the content
- `resolver`: <Type>Function</Type> | <Type>Any</Type>
- As a function, the function will be executed when the first get method is called on this content. The result of this function will define the content of this UID.
- `resolver(context, args)`
- `context`: <Type>{ Strapi }</Type> [See Strapi class documentation](Strapi.mdx)
- `args`: <Type>Any</Type> Anything to be used by the resolver function
- As anything else, this value will be resolved when getting this specified content through its UID.
Register a new content to be accessed inside the container. If the name is already used, it will throw an error.
```javascript
const container = createContainer(strapi);
container.register('config', ({ strapi }, args) => {});
// or
container.register('services', {});
```
### `container.get(name, args)` ### `container.get(name, args)`
- `name`: <Type>String</Type> UID of the content - `name`: <Type>String</Type> UID of the content
@ -56,6 +76,8 @@ const config = container.get('config');
⚠️ If the **resolver**, used in the [register function](#containerregistername-resolver), is a **function**, the value will be the result of this resolver function with `args` as parameter on the first call to `get`. ⚠️ If the **resolver**, used in the [register function](#containerregistername-resolver), is a **function**, the value will be the result of this resolver function with `args` as parameter on the first call to `get`.
Please pay attention that the resolver result value isn't awaited. So if resolver returns a promise, the value stored will be a promise.
```javascript ```javascript
const container = createContainer(strapi); const container = createContainer(strapi);
@ -73,27 +95,6 @@ container.get('boolean');
container.get('boolean', false); container.get('boolean', false);
// true // true
``` ```
### `container.register(name, resolver)`
- `name`: <Type>String</Type> UID of the content
- `resolver`: <Type>Function</Type> | <Type>Any</Type>
- As a function, the function will be executed when the first get method is called on this content. The result of this function will define the content of this UID.
- `resolver(context, args)`
- `context`: <Type>{ Strapi }</Type> [See Strapi class documentation](Strapi.mdx)
- `args`: <Type>Any</Type> Anything to be used by the resolver function
- As anything else, this value will be resolved when getting this specified content through its UID.
Register a new content to be accessed inside the container. If the name is already used, it will throw an error.
```javascript
const container = createContainer(strapi);
container.register('config', () => {});
// or
container.register('services', {});
```
### `container.extend()` ### `container.extend()`
To be developed To be developed