custom functions doc

danielaparker · Dec 11, 2024 · 0241ee7 · 0241ee7
1 parent b1b779a
commit 0241ee7
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 8 deletions.
diff --git a/doc/ref/jmespath/jmespath.md b/doc/ref/jmespath/jmespath.md
@@ -124,8 +124,8 @@ int main()
         }        
     )";
 
-    auto expr = jmespath::make_expression<json>("people[?age > `20`].[name, age]"); // since 0.159.0
-    // auto expr = jmespath::jmespath_expression<json>::compile("people[?age > `20`].[name, age]"); // until 0.159.0
+ // auto expr = jmespath::jmespath_expression<json>::compile("people[?age > `20`].[name, age]"); // until 0.159.0
+    auto expr = jmespath::make_expression<json>("people[?age > `20`].[name, age]");              // since 0.159.0
 
     json doc = json::parse(jtext);
 

diff --git a/doc/ref/jmespath/make_expression.md b/doc/ref/jmespath/make_expression.md
@@ -4,11 +4,20 @@
 #include <jsoncons_ext/jmespath/jmespath.hpp>
 
 template <typename Json>
-jmespath_expression<Json> make_expression(const json::string_view_type& expr); (1)
+jmespath_expression<Json> make_expression(const json::string_view_type& expr);        (until 1.0.0)
+                                                                                 (1)
+template <typename Json>
+jmespath_expression<Json> make_expression(const Json::string_view_type& expr,         (since 1.0.0)
+    const custom_functions<Json>& funcs = custom_functions<Json>());
+
+template <typename Json>
+jmespath_expression<Json> make_expression(const json::string_view_type& expr,    (2)
+    std::error_code& ec);                                                        
 
 template <typename Json>
-jmespath_expression<Json> make_expression(const json::string_view_type& expr,
-                                          std::error_code& ec); (2)
+jmespath_expression<Json> make_expression(const Json::string_view_type& expr,    (3) (since 1.0.0)  
+    const custom_functions<Json>& funcs,
+    std::error_code& ec)
 ```
 
 Returns a compiled JMESPath expression for later evaluation.
@@ -20,6 +29,10 @@ Returns a compiled JMESPath expression for later evaluation.
     <td>expr</td>
     <td>JMESPath expression</td> 
   </tr>
+  <tr>
+    <td>funcs</td>
+    <td>Custom functions</td> 
+  </tr>
   <tr>
     <td>ec</td>
     <td>out-parameter for reporting errors in the non-throwing overload</td> 

diff --git a/doc/ref/jsonpath/make_expression.md b/doc/ref/jsonpath/make_expression.md
@@ -54,6 +54,10 @@ jsonpath_expression<Json> make_expression(const allocator_set<Json::allocator_ty
     <td><code>expr</code></td>
     <td>JSONPath expression string</td> 
   </tr>
+  <tr>
+    <td><code>funcs</code></td>
+    <td>Custom functions</td> 
+  </tr>
   <tr>
     <td><code>ec</code></td>
     <td>out-parameter for reporting errors in the non-throwing overload</td> 

diff --git a/include/jsoncons_ext/jmespath/jmespath.hpp b/include/jsoncons_ext/jmespath/jmespath.hpp
@@ -5403,21 +5403,21 @@ namespace jmespath {
     }
 
     template <typename Json>
-    jmespath_expression<Json> make_expression(const typename json::string_view_type& expr,
+    jmespath_expression<Json> make_expression(const typename Json::string_view_type& expr,
         const jsoncons::jmespath::custom_functions<Json>& funcs = jsoncons::jmespath::custom_functions<Json>())
     {
         return jmespath_expression<Json>::compile(expr, funcs);
     }
 
     template <typename Json>
-    jmespath_expression<Json> make_expression(const typename json::string_view_type& expr,
+    jmespath_expression<Json> make_expression(const typename Json::string_view_type& expr,
         std::error_code& ec)
     {
         return jmespath_expression<Json>::compile(expr, ec);
     }
 
     template <typename Json>
-    jmespath_expression<Json> make_expression(const typename json::string_view_type& expr,
+    jmespath_expression<Json> make_expression(const typename Json::string_view_type& expr,
         const jsoncons::jmespath::custom_functions<Json>& funcs,
         std::error_code& ec)
     {