Overview

The CommonGrants.Fields namespace contains a standard set of fields that are used to build more complex models.

Fields

Learn more about the standard fields defined by the CommonGrants protocol:

Money A monetary amount with a currency code

Event A description of an event with an associated date

Custom Field A model for defining custom fields on a record

System Metadata System-managed metadata for records

Usage

You can use the fields listed above (along with basic data types) above to define custom models in your TypeSpec project.

import "@common-grants/core"

// Exposes the `Fields` and `Types` namespaces so that they can be accessed
// without a `CommonGrants` prefix
using CommonGrants;

model Widget {
  id: Types.uuid; // CommonGrants-defined type
  description: string; // Standard TypeSpec type
  price: Fields.Money; // CommonGrants-defined field
}