memconfig

memconfig.json is automatically generated and updated based on a program’s schema configured in the schema editor UI (bottom left of the IDE). You should rarely have to edit the file itself, although currently there are some features missing in the UI.

Descriptions

Types in a program’s schema can have descriptions.

{
  "name": "email",
  "type": "String",
  "description": "The user's email address"
}

Tip

The description field on a program’s Root type will be displayed in the Navigator when you hover over a program. It’ll also be used as the description when you publish a package.

Hints

Hints provided in memconfig.json indicate how fields should be displayed in the Navigator.

Preview

With preview hints, you can mark fields as primary and secondary to use them as previews in the Navigator, e.g. in a list of paginated results.

{
  "name": "number",
  "type": "String",
  "description": "The Pull Request number.",
  "hints": {
    "primary": true
  }
},
{
  "name": "title",
  "type": "String",
  "description": "The Pull Request title.",
  "hints": {
    "secondary": true
  }
}

Format

The format hint allows you to format a string as a URL in the Navigator.

{
  "name": "url",
  "type": "String",
  "description": "The URL of the Pull Request",
  "hints": {
    "format": "url"
  }
}

Hidden

The hidden hint can be used to mark a field that should not be displayed in the Navigator.

{
  "name": "phone_number",
  "type": "String",
  "description": "The customer's phone number",
  "hints": {
    "hidden": true
  }
}