emberjs/ember.js

Public `setModifierManager` is not documented

Open

#18.967 aberto em 12 de mai. de 2020

Ver no GitHub
 (3 comments) (3 reactions) (0 assignees)JavaScript (4.216 forks)batch import
DocumentationHelp Wanted

Métricas do repositório

Stars
 (22.437 stars)
Métricas de merge de PR
 (Mesclagem média 11d 14h) (20 fundiu PRs em 30d)

Description

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!

Guia do colaborador

Direção de pesquisa
Localize o arquivo fonte de setModifierManager no repositório ember.js e adicione comentários JSDoc descrevendo seu propósito e parâmetros conforme especificado no RFC.
Pilha de tecnologia
javascript
Domain
frontend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Ember.js basicsdocumentation writing
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90