module function · N/keyControl
findKeys()
keyControl.findKeys(options)
Searches and returns a list of keys based on criteria set.
- Implementation
- Not started
- Design
- Open for proposals suggest how it should read
A
suitescript api
1keyControl.findKeys({2 restriction: /* number, optional */,3 name: /* string or object, optional */,4 description: /* string or object, optional */5});
| Parameter | Type | Required | Description |
|---|---|---|---|
| options.restriction | number | optional | The internal ID of an employee selected in the Restrict to Employees field. |
| options.name | string or object | optional | The name of the key. The properties of the object are: value is a string, which can be used if object is used instead of string. operator is one of the keyControl.Operator enum values. ignoreCase is either true or false. If the object is used, the value is required. Operator defaults to equals and ignoreCase defaults to true. |
| options.description | string or object | optional | The description of the key. The properties of the object are: value is a string, which can be used if object is used instead of string. operator is one of the keyControl.Operator enum values. ignoreCase is either true or false. If the object is used, the value is required. Operator defaults to equals and ignoreCase defaults to true. |
B
mynt syntax
No Mynt syntax yet.
Nothing in the language compiles to keyControl.findKeys(options) today. How should it read?
C
community proposals
Competing syntax for findKeys, from GitHub Discussions. Select two or more to compare them side by side.
Loading proposals from GitHub…
D
suggest an alternative
Write the Mynt you wish you could write.
A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.
- Clarity. Does it say what happens, without ceremony?
- Consistency. Does it read like
load,saveandRef[field]? - Expressiveness. Does it cover the cases people actually write?
- Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?