This article explains the rules for naming LoopBack 3.x applications, models, data sources, and other project artifacts.
Page Contents

General rules

In general, names of LoopBack applications, models, data sources, and so on must at a minimum be valid JavaScript identifiers, with the additional restriction that the dollar sign ($) is not allowed.

The rules for JavaScript identifiers are fairly broad (for example, you can use Unicode characters). However, as a best practice, follow these more restrictive guidelines:

  • Begin names with a letter or underscore (_). Don’t begin a name with a number.
  • Other characters can be letters, numbers, or underscore (_).
  • Application names can contain the dash, that is, the minus-sign character (-).

Reserved model names

The following names cannot be used as a model name (case insensitively):

  • Any
  • Array
  • Boolean
  • Date
  • File
  • Integer
  • Number
  • Object
  • String