Skip to content

Commit 079f68a

Browse files
committed
📝 mark expr_string module as deprecated
1 parent 08abcca commit 079f68a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

helper/expr_string.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
* ```
2424
*
2525
* @module
26+
* @deprecated Use {@linkcode rawString}
2627
*/
2728
import type { Context, Denops, Dispatcher, Meta } from "@denops/core";
2829
import { isArray } from "@core/unknownutil/is/array";
@@ -40,10 +41,16 @@ import { isUndefined } from "@core/unknownutil/is/undefined";
4041
import { ulid } from "@std/ulid";
4142
import { execute } from "./execute.ts";
4243

44+
// Note: Imports only types and is used only in tsdoc.
45+
// deno-lint-ignore no-unused-vars
46+
import type { isRawString, RawString, rawString } from "../eval/string.ts";
47+
4348
const EXPR_STRING_MARK = "__denops_expr_string";
4449

4550
/**
4651
* String that marked as Vim's string constant format.
52+
*
53+
* @deprecated Use {@linkcode rawString} and {@linkcode RawString}
4754
*/
4855
export type ExprString = string & {
4956
/**
@@ -95,6 +102,7 @@ async function ensurePrerequisites(denops: Denops): Promise<string> {
95102
* ```
96103
*
97104
* @see useExprString for usage
105+
* @deprecated Use {@linkcode rawString}
98106
*/
99107
export function exprQuote(
100108
template: TemplateStringsArray,
@@ -119,6 +127,8 @@ const isInstanceOfString = isInstanceOf(String);
119127
* console.log(isExprString(exprQuote`foo`)); // outputs: true
120128
* console.log(isExprString("foo")); // outputs: false
121129
* ```
130+
*
131+
* @deprecated Use {@linkcode rawString} and {@linkcode isRawString}
122132
*/
123133
export function isExprString(x: unknown): x is ExprString {
124134
return isObjectOf({

0 commit comments

Comments
 (0)