There may exist a use case in which you need to ensure that a given key is escaped correctly based on dot notation. For this reason, v3.0.0 introduced two new functions escape and isEscaped.

They're pretty much as straightforward as they sound; escape will wrap your key up in whatever is needed to ensure valid dot notation, whilst isEscaped will simply tell you if a key is already in dot notation. It should be noted that these functions are to be used with a key, not a dot notation path.

For example;

var dots = require('dot-notes');
var text = 'test-string';
if (!dots.isEscaped(text)) { // true
  text = dots.escape(text);  // ["test-string"]
}