summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/js/package/lib/CodePointRangeIteratorResult.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'intl/icu_capi/js/package/lib/CodePointRangeIteratorResult.d.ts')
-rw-r--r--intl/icu_capi/js/package/lib/CodePointRangeIteratorResult.d.ts13
1 files changed, 13 insertions, 0 deletions
diff --git a/intl/icu_capi/js/package/lib/CodePointRangeIteratorResult.d.ts b/intl/icu_capi/js/package/lib/CodePointRangeIteratorResult.d.ts
new file mode 100644
index 0000000000..bcc72a65a6
--- /dev/null
+++ b/intl/icu_capi/js/package/lib/CodePointRangeIteratorResult.d.ts
@@ -0,0 +1,13 @@
+import { u32 } from "./diplomat-runtime"
+
+/**
+
+ * Result of a single iteration of {@link CodePointRangeIterator `CodePointRangeIterator`}. Logically can be considered to be an `Option<RangeInclusive<u32>>`,
+
+ * `start` and `end` represent an inclusive range of code points start, end, and `done` will be true if the iterator has already finished. The last contentful iteration will NOT produce a range done=true, in other words `start` and `end` are useful values if and only if `done=false`.
+ */
+export class CodePointRangeIteratorResult {
+ start: u32;
+ end: u32;
+ done: boolean;
+}