UNPKG

@toreda/strong-types

Version:

Better TypeScript code in fewer lines.

1 lines 2.02 kB
{"version":3,"sources":["../src/map/parser/options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB","file":"options.d.ts","sourcesContent":["/**\n *\tMIT License\n *\n *\tCopyright (c) 2019 - 2021 Toreda, Inc.\n *\n *\tPermission is hereby granted, free of charge, to any person obtaining a copy\n *\tof this software and associated documentation files (the \"Software\"), to deal\n *\tin the Software without restriction, including without limitation the rights\n *\tto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n *\tcopies of the Software, and to permit persons to whom the Software is\n *\tfurnished to do so, subject to the following conditions:\n\n * \tThe above copyright notice and this permission notice shall be included in all\n * \tcopies or substantial portions of the Software.\n *\n * \tTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n *\tIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n *\tFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * \tAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n *\tLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n *\tOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * \tSOFTWARE.\n *\n */\n\n/**\n * Options used to initialize internal parser state.\n *\n * @category Strong Map\n */\nexport interface MapParserOptions {\n\t/**\n\t * \tRecursively parse map and all children up to and including children at\n\t * \tthe specified max parse depth.\n\t *\t\tDepth 0 - Properties on map.\n\t *\t\t\tmap -> childProp\n\t *\t\tDepth 1 - Children of map properties.\n\t *\t\t\tmap -> childProp -> childProp\n\t *\t\tDepth 2 - Children of Children of map properties.\n\t *\t\t\tmap -> childProp -> childProp -> childProp\n\t *\t\t(etc)\n\t */\n\tparseDepthMax?: number;\n}\n"]}