mirror of
https://github.com/sern-handler/website
synced 2026-06-06 01:16:47 +00:00
156 lines
2.9 KiB
Markdown
156 lines
2.9 KiB
Markdown
---
|
|
id: "ModuleManager"
|
|
title: "Interface: ModuleManager"
|
|
sidebar_label: "ModuleManager"
|
|
sidebar_position: 0
|
|
custom_edit_url: null
|
|
---
|
|
|
|
**`Since`**
|
|
|
|
2.0.0
|
|
- direct access to the module manager will be removed in version 4
|
|
|
|
## Hierarchy
|
|
|
|
- `MetadataAccess`
|
|
|
|
↳ **`ModuleManager`**
|
|
|
|
## Implemented by
|
|
|
|
- [`DefaultModuleManager`](../classes/DefaultModuleManager.md)
|
|
|
|
## Methods
|
|
|
|
### get
|
|
|
|
▸ **get**(`id`): `undefined` \| `Module`
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `id` | `string` |
|
|
|
|
#### Returns
|
|
|
|
`undefined` \| `Module`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/contracts/module-manager.ts:19](https://github.com/sern-handler/handler/blob/91b3768e376cfe22ec37d8ab44f4e4a4dfe8a1e8/src/core/contracts/module-manager.ts#L19)
|
|
|
|
___
|
|
|
|
### getByNameCommandType
|
|
|
|
▸ **getByNameCommandType**<`T`\>(`name`, `commandType`): `undefined` \| [`CommandModuleDefs`](CommandModuleDefs.md)[`T`]
|
|
|
|
#### Type parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `T` | extends [`CommandType`](../enums/CommandType.md) |
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `name` | `string` |
|
|
| `commandType` | `T` |
|
|
|
|
#### Returns
|
|
|
|
`undefined` \| [`CommandModuleDefs`](CommandModuleDefs.md)[`T`]
|
|
|
|
#### Defined in
|
|
|
|
[src/core/contracts/module-manager.ts:30](https://github.com/sern-handler/handler/blob/91b3768e376cfe22ec37d8ab44f4e4a4dfe8a1e8/src/core/contracts/module-manager.ts#L30)
|
|
|
|
___
|
|
|
|
### getMetadata
|
|
|
|
▸ **getMetadata**(`m`): `undefined` \| `CommandMeta`
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `m` | `Module` |
|
|
|
|
#### Returns
|
|
|
|
`undefined` \| `CommandMeta`
|
|
|
|
#### Inherited from
|
|
|
|
MetadataAccess.getMetadata
|
|
|
|
#### Defined in
|
|
|
|
[src/core/contracts/module-manager.ts:10](https://github.com/sern-handler/handler/blob/91b3768e376cfe22ec37d8ab44f4e4a4dfe8a1e8/src/core/contracts/module-manager.ts#L10)
|
|
|
|
___
|
|
|
|
### getPublishableCommands
|
|
|
|
▸ **getPublishableCommands**(): [`CommandModule`](../modules.md#commandmodule)[]
|
|
|
|
#### Returns
|
|
|
|
[`CommandModule`](../modules.md#commandmodule)[]
|
|
|
|
**`Deprecated`**
|
|
|
|
#### Defined in
|
|
|
|
[src/core/contracts/module-manager.ts:25](https://github.com/sern-handler/handler/blob/91b3768e376cfe22ec37d8ab44f4e4a4dfe8a1e8/src/core/contracts/module-manager.ts#L25)
|
|
|
|
___
|
|
|
|
### set
|
|
|
|
▸ **set**(`id`, `path`): `void`
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `id` | `string` |
|
|
| `path` | `Module` |
|
|
|
|
#### Returns
|
|
|
|
`void`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/contracts/module-manager.ts:21](https://github.com/sern-handler/handler/blob/91b3768e376cfe22ec37d8ab44f4e4a4dfe8a1e8/src/core/contracts/module-manager.ts#L21)
|
|
|
|
___
|
|
|
|
### setMetadata
|
|
|
|
▸ **setMetadata**(`m`, `c`): `void`
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `m` | `Module` |
|
|
| `c` | `CommandMeta` |
|
|
|
|
#### Returns
|
|
|
|
`void`
|
|
|
|
#### Inherited from
|
|
|
|
MetadataAccess.setMetadata
|
|
|
|
#### Defined in
|
|
|
|
[src/core/contracts/module-manager.ts:11](https://github.com/sern-handler/handler/blob/91b3768e376cfe22ec37d8ab44f4e4a4dfe8a1e8/src/core/contracts/module-manager.ts#L11)
|