module function · N/search

createFilter()

search.createFilter(options)

Creates a new search filter as a search.Filter object.

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A
Signature
search.createFilter(options)
Module
N/search
Returns
search.Filter
Governance
None
Script types
Client and server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2015.2
call shapefrom Oracle's parameter table
1search.createFilter({2    name:     /* string, required */,3    join:     /* string, optional */,4    operator: /* string, required */,5    values:   /* string | Date | number | boolean | string[] | Date[] | number[], optional */,6    formula:  /* string, optional */,7    summary:  /* string, optional */8});
Oracle reference for this method
ParameterTypeRequiredDescription
options.namestringrequiredName or internal ID of the search field.
options.joinstringoptionalJoin ID for the search filter.
options.operatorstringrequiredOperator used for the search filter. Use the search.Operator enum.
options.valuesstring | Date | number | boolean | string[] | Date[] | number[]optionalValues to be used as filter parameters.
options.formulastringoptionalFormula used by the search filter.
options.summarystringoptionalSummary type for the search filter. See search.Summary .
B

No Mynt syntax yet.

Nothing in the language compiles to search.createFilter(options) today. How should it read?

C

Competing syntax for createFilter, from GitHub Discussions. Select two or more to compare them side by side.

All discussions

Loading proposals from GitHub…

D

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, save and Ref[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?

N/search · search.createFilter(options)

Suggest syntax for createFilter