rescript-lang / rescript-lang/experimental-rescript-webapi

Improve generated overloads

Ouverte
#27 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

help wanted
Langage dominant
ReScript
Étoiles
40
Forks
11
Merge moyen
3 j 12 h
PR mergées (30 j)
12

Description

The initial batch of bindings was generated. Some methods have generated overloads.
We should try and improve these manually.
Either via:

  • Renaming to hold a more suitable underscore suffix. (See addEventListener as example)
  • Remove some of these overloads if they don't make sense. (Like setTimeout taking a string as argument).
src/Global.res
  • setTimeout2
  • setInterval2
  • createImageBitmap18
  • alert2
  • postMessage2
  • scroll2
  • scrollTo2
  • scrollBy2
src/CanvasAPI/Path2D.res
  • make2
  • roundRect3
src/IndexedDBAPI/IDBObjectStore.res
  • createIndex2
src/IndexedDBAPI/IDBDatabase.res
  • transaction2
src/DOMAPI/HTMLInputElement.res
  • setRangeText2
src/DOMAPI/Element.res
  • after2
  • animate2
  • append2
  • before2
  • prepend2
  • replaceChildren2
  • replaceWith2
  • scroll2
  • scrollBy2
  • scrollTo2
src/DOMAPI/DOMMatrixReadOnly.res
  • make2
src/DOMAPI/HTMLCanvasElement.res
  • getContext_WebGL2
src/DOMAPI/VideoFrame.res
  • make10
  • copyTo3
src/DOMAPI/HTMLTextAreaElement.res
  • setRangeText2
src/DOMAPI/Navigator.res
  • sendBeacon7
  • vibrate2
src/DOMAPI/Document.res
  • prepend2
  • append2
  • replaceChildren2
  • createElement2
  • createElementNS2
  • open2
src/DOMAPI/CanvasRenderingContext2D.res
  • setTransform2
  • createPattern7
  • fill2
  • stroke2
  • clip2
  • isPointInPath2
  • isPointInStroke2
  • drawFocusIfNeeded2
  • drawImage21
  • createImageData2
  • putImageData2
  • roundRect3
src/DOMAPI/DOMMatrix.res
  • make2
src/DOMAPI/HTMLSlotElement.res
  • assign2
src/DOMAPI/Window.res
  • setTimeout2
  • setInterval2
  • createImageBitmap18
  • alert2
  • postMessage2
  • scroll2
  • scrollTo2
  • scrollBy2
src/DOMAPI/CharacterData.res
  • after2
  • before2
  • replaceWith2
src/DOMAPI/ImageData.res
  • make2
src/DOMAPI/DocumentFragment.res
  • append2
  • prepend2
  • replaceChildren2
src/DOMAPI/StylePropertyMap.res
  • set2
  • append2
src/DOMAPI/HTMLSelectElement.res
  • removeH2
src/CSSFontLoadingAPI/FontFace.res
  • make3
src/WebSocketsAPI/WebSocket.res
  • make2
  • send4
src/WebLocksAPI/LockManager.res
  • request2
src/EncryptedMediaExtensionsAPI/MediaKeys.res
  • setServerCertificate2
src/EncryptedMediaExtensionsAPI/MediaKeySession.res
  • generateRequest2
  • update2
src/EncryptedMediaExtensionsAPI/MediaKeyStatusMap.res
  • has2
src/ChannelMessagingAPI/MessagePort.res
  • postMessage2
src/FetchAPI/FormData.res
  • append2
  • get2
  • set2
src/FetchAPI/Headers.res
  • make2
src/FetchAPI/Request.res
  • make2
src/FetchAPI/Response.res
  • make7
src/FetchAPI/URLSearchParams.res
  • make3
src/PerformanceAPI/Performance.res
  • measure2
src/ServiceWorkerAPI/Cache.res
  • match2
  • matchAll2
  • add2
  • put2
  • delete2
  • keys2
src/ServiceWorkerAPI/ServiceWorker.res
  • postMessage2
src/ServiceWorkerAPI/CacheStorage.res
  • match2
src/FileAPI/ReadableStream.res
  • make3
src/FileAPI/FileSystemWritableFileStream.res
  • write5
src/MediaCaptureAndStreamsAPI/MediaStream.res
  • make3
src/WebAudioAPI/OfflineAudioContext.res
  • make2
src/WebCryptoAPI/SubtleCrypto.res
  • generateKey2
  • deriveBits2
  • wrapKey2
src/UIEventsAPI/DataTransferItemList.res
  • add2

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les fichiers générés listés sous src/, en utilisant Global.res et DOMAPI/Element.res comme exemples initiaux. Comparez les références d’API de addEventListener et setTimeout, puis examinez chaque surcharge cochée afin de déterminer un suffixe approprié ou sa suppression ; le travail est considéré comme terminé lorsque les décisions de la checklist sont appliquées de manière cohérente à l’ensemble des bindings concernés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
web-dev
Type d'issue
Refactorisation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.