codex-team/editor.js

API: improve block.insert() interface to allow passing parameters as an object instead of set

Open

#1 817 ouverte le 24 nov. 2021

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)TypeScript (1 985 forks)batch import
good first issue

Métriques du dépôt

Stars
 (26 602 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

  1. Describe a problem.

The current interface of the api.blocks.insert accepts parameters as a list:

this.api.blocks.insert(
      toolName,
      undefined,
      undefined,
      index,
      undefined,
      currentBlock.isEmpty
);
  1. Describe the solution you'd like. Mockups are welcome.

It would better to pass parameters as an object:

this.api.blocks.insert({
  type: toolName,
  index,
  replace: currentBlock.isEmpty
});

Important. We need to save the backward capability.

Guide contributeur

Direction de recherche
Implémentez une fonction surchargée ou utilisez la déstructuration d'objet pour accepter à la fois les paramètres positionnels et d'objet. Assurez la rétrocompatibilité et mettez à jour les tests.
Stack technique
typescript
Domaine
frontend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70