implicit conversion from underlying type to @:enum abstracts

オープン
#19 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
静か
技術スタック
nodejs
領域
backend

調査の方向性

js/node/Fs.hx の SymlinkType abstract と fs.symlink の型パラメーターから始め、リンクされている Node.js API ドキュメントで受け入れられる値を確認します。String の変換をサポートすべきかを明らかにし、選択した型付けと検証の方針を externs に反映できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

For instance, fs.symlink accepts the type parameter that is String with predefined values in JS: dir, file and junction (see http://nodejs.org/api/fs.html#fs_fs_symlink_srcpath_dstpath_type_callback).

For those values, we provide a @:enum abstract SymlinkType (see https://github.com/HaxeFoundation/hxnodejs/blob/3ca255f7842ca25ce90f7c4ce9651b21bf150a7b/js/node/Fs.hx#L51)

The question is: should we add from String to that abstract?

  • if we don't, user won't be able to just copy-paste js code and will have to change strings to enum values
  • if we do, user may pass an invalid string so we lose strict typing

Another option is add a @:from method with validation, but I don't think that's a good idea because that would add runtime cost (we could only add it in -debug mode tho).

主要言語
Haxe
スター
177
フォーク
58
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

HaxeFoundation/hxnodejs のほかの issue

HaxeFoundation/hxnodejs の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。