sanity-plugin-taxonomy-manager 3.0.0 → 3.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -2,6 +2,14 @@
2
2
 
3
3
  import {Plugin as Plugin_2} from 'sanity'
4
4
 
5
+ /**
6
+ * Document Branch Filter
7
+ *
8
+ * A pluggable Function for Filtering to a Top Concept Branch within a SKOS Concept Scheme
9
+ * @param options.schemeId The unique six character concept identifier for the Concept Scheme to which you wish to filter.
10
+ * @param options.branchId The unique six character concept identifier of a branch. Child concepts will be returned.
11
+ * @returns A reference type filter for the child concepts of the designated branch in the selected Concept Scheme
12
+ */
5
13
  export declare function branchFilter(options: BranchOptions): BranchFilterResult
6
14
 
7
15
  declare type BranchFilterResult = {
@@ -9,9 +17,6 @@ declare type BranchFilterResult = {
9
17
  params: BranchOptions
10
18
  }
11
19
 
12
- /**
13
- * Pluggable Function for Filtering to a Top Concept Branch within a SKOS Concept Scheme
14
- */
15
20
  declare type BranchOptions = {
16
21
  schemeId: string
17
22
  branchId: string
@@ -21,6 +26,13 @@ declare interface Options {
21
26
  baseUri?: string
22
27
  }
23
28
 
29
+ /**
30
+ * Document Scheme Filter
31
+ *
32
+ * Pluggable Function for Filtering to a Single SKOS Concept Scheme
33
+ * @param options.schemeId The unique six character concept identifier for the Concept Scheme to which you wish to filter.
34
+ * @returns A reference type filter for Concepts and Top Concepts in the selected Concept Scheme
35
+ */
24
36
  export declare function schemeFilter(options: SchemeOptions): SchemeFilterResult
25
37
 
26
38
  declare type SchemeFilterResult = {
@@ -28,9 +40,6 @@ declare type SchemeFilterResult = {
28
40
  params: SchemeOptions
29
41
  }
30
42
 
31
- /**
32
- * Pluggable Function for Filtering to a Single SKOS Concept Scheme
33
- */
34
43
  declare type SchemeOptions = {
35
44
  schemeId: string
36
45
  }