editor-js / editor-js/checklist

Output format: Which properties (if any) can be null omitted?

Open
#19 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
68
Forks
34
PR merge metrics
No merged PRs in 30d

Description

For a valid checklist block, under any circumstances (now or in the future) :
* Can the `items` property be `null` or omitted?
* Can any array element in `items` be `null`?
* Can the `text` or `checked` properties of any item be `null` or omitted?

Or are all of the aforementioned properties/values guaranteed to always be present and non-`null` for this block to be valid?

Context: I'm a back-end .NET developer needing to parse Editor.js documents. The readme lists all of the aforementioned properties/values but does not explicitly guarantee that they will always be present and non-null. Back-end deserialization/parsing in strongly typed languages would be easier with some guarantees about which properties can and can not be null/omitted. (Ideally, any such guarantees should be added to the readme to ensure they are formalized and kept in the future.)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.