summaryrefslogtreecommitdiff
path: root/alarm/node_modules/graphql/utilities/stripIgnoredCharacters.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'alarm/node_modules/graphql/utilities/stripIgnoredCharacters.d.ts')
-rw-r--r--alarm/node_modules/graphql/utilities/stripIgnoredCharacters.d.ts55
1 files changed, 55 insertions, 0 deletions
diff --git a/alarm/node_modules/graphql/utilities/stripIgnoredCharacters.d.ts b/alarm/node_modules/graphql/utilities/stripIgnoredCharacters.d.ts
new file mode 100644
index 0000000..a131af0
--- /dev/null
+++ b/alarm/node_modules/graphql/utilities/stripIgnoredCharacters.d.ts
@@ -0,0 +1,55 @@
+import { Source } from '../language/source';
+
+/**
+ * Strips characters that are not significant to the validity or execution
+ * of a GraphQL document:
+ * - UnicodeBOM
+ * - WhiteSpace
+ * - LineTerminator
+ * - Comment
+ * - Comma
+ * - BlockString indentation
+ *
+ * Note: It is required to have a delimiter character between neighboring
+ * non-punctuator tokens and this function always uses single space as delimiter.
+ *
+ * It is guaranteed that both input and output documents if parsed would result
+ * in the exact same AST except for nodes location.
+ *
+ * Warning: It is guaranteed that this function will always produce stable results.
+ * However, it's not guaranteed that it will stay the same between different
+ * releases due to bugfixes or changes in the GraphQL specification.
+ *
+ * Query example:
+ *
+ * query SomeQuery($foo: String!, $bar: String) {
+ * someField(foo: $foo, bar: $bar) {
+ * a
+ * b {
+ * c
+ * d
+ * }
+ * }
+ * }
+ *
+ * Becomes:
+ *
+ * query SomeQuery($foo:String!$bar:String){someField(foo:$foo bar:$bar){a b{c d}}}
+ *
+ * SDL example:
+ *
+ * """
+ * Type description
+ * """
+ * type Foo {
+ * """
+ * Field description
+ * """
+ * bar: String
+ * }
+ *
+ * Becomes:
+ *
+ * """Type description""" type Foo{"""Field description""" bar:String}
+ */
+export function stripIgnoredCharacters(source: string | Source): string;