Public `setModifierManager` is not documented · emberjs/ember.js#18967

(3 comments) (3 reactions) (0 assignees)JavaScript (22,437 stars) (4,216 forks)batch import

DocumentationHelp Wanted

説明

The merged RFC specifies a public import setModifierManager:

Ember will provide a new API to assign the modifier manager for a element modifier class:

// my-app/app/modifier/foo.js

import EmberObject from '@ember/object';
import { createManager } from './basic-manager';
import { setModifierManager } from '@ember/modifier';

export default setModifierManager(createManager, EmberObject.extend({
  // ...
}));
// my-app/app/modifier/basic-manager.js

// ...

export function createManager(owner) {
  return new BasicManager(owner);
}
setModifierManager takes two parameters. The first parameter is a function that takes an Owner and returns an instance of a manager. The second parameter is the base class that applications would extend from.

Currently, setModifierManager is undocumented:

https://github.com/emberjs/ember.js/blob/ef3688b0986d06f4902166d8433a0441ae70af46/packages/%40ember/-internals/glimmer/lib/utils/custom-modifier-manager.ts#L1-L5

We should document it!

コントリビューターガイド

技術スタック: javascripttypescript
領域: documentation
Issue 種別: documentation
難度: 2
推定時間: under 1 hour
活動状況: stale
明確さ: clear
前提条件: Basic knowledge of Ember.js
初心者向け度: 80
調査方針: The issue requests documenting the public `setModifierManager` function. The source file is located at `packages/@ember/ internals/glimmer/lib/utils/custom modifier manager.ts`. Refer to the merged RFC (https://github.com/emberjs/rfcs/blob/f0a9b20d898013994b01670a35f868c229b2771b/text/0373 Element Modifier Managers.md) for the intended API and description. Add JSDoc comments to the function explaining its parameters (a function that takes an Owner and returns a manager instance, and a base class) and its purpose. Ensure the documentation follows existing patterns in the codebase.