Adding comments
This commit is contained in:
parent
70e17ec2f1
commit
ae2204d470
@ -124,7 +124,7 @@ export function rqueryAttr<T>(
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Helper to query data from an object.
|
* Helper to query data from an object.
|
||||||
*
|
*
|
||||||
* props is defined as followed:
|
* props is defined as followed:
|
||||||
* ```typescript
|
* ```typescript
|
||||||
* props: {
|
* props: {
|
||||||
@ -133,10 +133,10 @@ export function rqueryAttr<T>(
|
|||||||
* }[]
|
* }[]
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* @example Example 1:
|
* @example Example 1:
|
||||||
*
|
*
|
||||||
* ```javascript
|
* ```javascript
|
||||||
*
|
*
|
||||||
* const data = { "deep": { "nested": "test" } };
|
* const data = { "deep": { "nested": "test" } };
|
||||||
* const result = convert_data(data, [
|
* const result = convert_data(data, [
|
||||||
* {
|
* {
|
||||||
@ -144,12 +144,12 @@ export function rqueryAttr<T>(
|
|||||||
* "query": "deep/nested",
|
* "query": "deep/nested",
|
||||||
* },
|
* },
|
||||||
* ]);
|
* ]);
|
||||||
*
|
*
|
||||||
* // ==> result = [{"result": "test"}]
|
* // ==> result = [{"result": "test"}]
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* @example Example 2:
|
* @example Example 2:
|
||||||
*
|
*
|
||||||
* ```javascript
|
* ```javascript
|
||||||
* data = {
|
* data = {
|
||||||
* "array": [
|
* "array": [
|
||||||
@ -177,8 +177,8 @@ export function rqueryAttr<T>(
|
|||||||
* ])
|
* ])
|
||||||
*
|
*
|
||||||
* // ==> result = [{"a": 0, "b": "a"}, {"a": 1, "b": "a"}]
|
* // ==> result = [{"a": 0, "b": "a"}, {"a": 1, "b": "a"}]
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
* @param data The data
|
* @param data The data
|
||||||
* @param query The query to use.
|
* @param query The query to use.
|
||||||
* @returns Returns an array
|
* @returns Returns an array
|
||||||
|
@ -17,12 +17,12 @@ export function convertPath(path: string): string {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the least common segmet of all pathes, included in the pathes array.
|
* Returns the least common segmet of all pathes, included in the pathes array.
|
||||||
*
|
*
|
||||||
* The Following options are available.
|
* The Following options are available.
|
||||||
*
|
*
|
||||||
* "considerSingleLevel":boolean -> allows "singlelevel"-wildcards in the segments
|
* "considerSingleLevel":boolean -> allows "singlelevel"-wildcards in the segments
|
||||||
* "considerMultiLevel":boolean -> allows "multilevel"-wildcards in the segments
|
* "considerMultiLevel":boolean -> allows "multilevel"-wildcards in the segments
|
||||||
*
|
*
|
||||||
* @param pathes The Segments to compare
|
* @param pathes The Segments to compare
|
||||||
* @param opts Additional Options.
|
* @param opts Additional Options.
|
||||||
* @returns
|
* @returns
|
||||||
|
Loading…
Reference in New Issue
Block a user