shinkansen-rails

Shinkansen Rails

Usage no npm install needed!

<script type="module">
  import shinkansenRails from 'https://cdn.skypack.dev/shinkansen-rails';
</script>

README

`shinkansen-rails`

Shinkansen Rails

Rails transforms objects into strings to be consumed by <Link /> components for React Router.

Usage

import {
  Rails
} from 'shinkansen-rails'

Rails exposes the methods pattern, go, to, and rail.

export class Rails {
  static pattern () { }
  static go () { }
  static to () { }
  static rail () { }
}

pattern returns a string which is the transformation pattern
go returns a boolean which describes whether an object can be transformed by the pattern
to returns a string which is the product of that transformation
rail caches and returns a product of to

The method rail should be used whenever the computation is (or expected to be) idempotent.

See also