Skip to content

Commit

Permalink
Explain search only fields in Readme
Browse files Browse the repository at this point in the history
Attempt to document NetSweet#483.

I wasn't sure how best to convey this given it affects consuming the search results, not performing the search itself. It should also be unsurprising that you'd access these search-only fields the same way you'd access regular or read-only fields.

Had we buried these search-only fields in custom fields, like NetSweet#426 first attempted, then I'd find that more surprising and warranting clearer documentation.
  • Loading branch information
cgunther authored Aug 11, 2021
1 parent a8395e3 commit 3bdecfe
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,10 @@ NetSuite::Records::SalesOrder.search({
'tranSales:basic' => [
'platformCommon:internalId/' => {},
'platformCommon:email/' => {},
'platformCommon:tranDate/' => {}
'platformCommon:tranDate/' => {},
# If you include columns that are only part of the *SearchRowBasic (ie. TransactionSearchRowBasic),
# they'll be readable on the resulting record just like regular fields (my_record.close_date).
'platformCommon:closeDate/' => {}
],
'tranSales:accountJoin' => [
'platformCommon:internalId/' => {}
Expand Down

0 comments on commit 3bdecfe

Please sign in to comment.