ericelliott / rtype

Intuitive structural type notation for JavaScript.
MIT License
1.13k stars 38 forks source link

`effects` keyword to describe side-effects #125

Open ericelliott opened 7 years ago

ericelliott commented 7 years ago

A way to describe side-effects in prose for documentation purposes, e.g.:

log(value) => Void, effects( log to console )

You can spread the description over multiple lines:

log(value) => Void, effects(
  log to console,
  POST to logging server
)
timkendall commented 7 years ago

This would be spicy 🌶