Skip to content

Commit

Permalink
fix(shared): unwrap refs in toDisplayString (#7306)
Browse files Browse the repository at this point in the history
close #5578
close #5593
close #11199
close #11201
  • Loading branch information
skirtles-code authored Jun 23, 2024
1 parent 582cd2e commit 0126cff
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
16 changes: 16 additions & 0 deletions packages/shared/__tests__/toDisplayString.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,28 @@ describe('toDisplayString', () => {
})

test('primitive values', () => {
expect(toDisplayString(0)).toBe('0')
expect(toDisplayString(1)).toBe('1')
expect(toDisplayString(NaN)).toBe('NaN')
expect(toDisplayString(true)).toBe('true')
expect(toDisplayString(false)).toBe('false')
expect(toDisplayString('hello')).toBe('hello')
})

test('primitive values in refs', () => {
expect(toDisplayString(ref(0))).toBe('0')
expect(toDisplayString(ref(1))).toBe('1')
expect(toDisplayString(ref(NaN))).toBe('NaN')
expect(toDisplayString(ref(true))).toBe('true')
expect(toDisplayString(ref(false))).toBe('false')
expect(toDisplayString(ref('hello'))).toBe('hello')
})

test('symbol values', () => {
expect(toDisplayString(Symbol('hello'))).toBe('Symbol(hello)')
expect(toDisplayString(ref(Symbol('hello')))).toBe('Symbol(hello)')
})

test('Object and Arrays', () => {
const obj = { foo: 123 }
expect(toDisplayString(obj)).toBe(JSON.stringify(obj, null, 2))
Expand Down
14 changes: 10 additions & 4 deletions packages/shared/src/toDisplayString.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ import {
objectToString,
} from './general'

// can't use isRef here since @vue/shared has no deps
const isRef = (val: any): val is { value: unknown } => {
return !!(val && val.__v_isRef === true)
}

/**
* For converting {{ interpolation }} values to displayed strings.
* @private
Expand All @@ -22,13 +27,14 @@ export const toDisplayString = (val: unknown): string => {
: isArray(val) ||
(isObject(val) &&
(val.toString === objectToString || !isFunction(val.toString)))
? JSON.stringify(val, replacer, 2)
? isRef(val)
? toDisplayString(val.value)
: JSON.stringify(val, replacer, 2)
: String(val)
}

const replacer = (_key: string, val: any): any => {
// can't use isRef here since @vue/shared has no deps
if (val && val.__v_isRef) {
const replacer = (_key: string, val: unknown): any => {
if (isRef(val)) {
return replacer(_key, val.value)
} else if (isMap(val)) {
return {
Expand Down

0 comments on commit 0126cff

Please sign in to comment.