codex-team/editor.js

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

Open

#1,817 opened on Nov 24, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (1,985 forks)batch import
good first issue

Repository metrics

Stars
 (26,602 stars)
PR merge metrics
 (No merged PRs in 30d)

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.

Contributor guide

Research direction
Implement overloaded function or use object destructuring to accept both positional and object parameters. Ensure backward compatibility and update tests.
Tech stack
typescript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70