Skip to content

Shared Verbs

A file in verbs/ declares one Verb that several Nouns share, with its inverse and input, once.

A file in verbs/ declares one Verb that several Nouns share. It states the Verb once, so Lease.renew and Contract.renew mean the same thing.

  • verbs/
  • renew.mdxrenew, shared by Lease and Contract

Reference

MDX. Frontmatter is the Verb; the body is its documentation.

KeyTypeHolds
nounsNoun namesThe Nouns that take the Verb
inverseverbThe Verb that undoes it
inputmapThe input every Noun's form shares
formsmapIrregular forms only, such as doneBy

Examples

Minimal

verbs/renew.mdx
---
nouns: [Lease]
---

Leaseline

Leaseline declares a Lease Noun and a Contract Noun for its own vendor agreements.

verbs/renew.mdx
---
nouns: [Lease, Contract]
inverse: lapse
input:
  months: number
---
Renewing extends an agreement by a term; lapsing ends it on its end date.

What it builds

The SoftwareBuilder compiles one Verb onto each listed Noun.

  • Lease.renew, Contract.renew and the inverse lapse on each
  • the Events Lease.renewed and Contract.renewed
  • one input type, shared by every Noun that takes the Verb

Good to know

  • A Verb declared in a Noun file and in verbs/ fails the parse check.
  • Each Noun keeps its own Verb function.
  • Shared Verbs lists every Verb the platform already shares.