Spaces:
Running
Running
File size: 9,552 Bytes
c2b7eb3 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 | import type {
Action,
ActionCreator,
ActionCreatorWithNonInferrablePayload,
ActionCreatorWithOptionalPayload,
ActionCreatorWithPayload,
ActionCreatorWithPreparedPayload,
ActionCreatorWithoutPayload,
PayloadAction,
PayloadActionCreator,
UnknownAction,
} from '@reduxjs/toolkit'
import { createAction } from '@reduxjs/toolkit'
describe('type tests', () => {
describe('PayloadAction', () => {
test('PayloadAction has type parameter for the payload.', () => {
const action: PayloadAction<number> = { type: '', payload: 5 }
expectTypeOf(action.payload).toBeNumber()
expectTypeOf(action.payload).not.toBeString()
})
test('PayloadAction type parameter is required.', () => {
expectTypeOf({ type: '', payload: 5 }).not.toMatchTypeOf<PayloadAction>()
})
test('PayloadAction has a string type tag.', () => {
expectTypeOf({ type: '', payload: 5 }).toEqualTypeOf<
PayloadAction<number>
>()
expectTypeOf({ type: 1, payload: 5 }).not.toMatchTypeOf<PayloadAction>()
})
test('PayloadAction is compatible with Action<string>', () => {
const action: PayloadAction<number> = { type: '', payload: 5 }
expectTypeOf(action).toMatchTypeOf<Action<string>>()
})
})
describe('PayloadActionCreator', () => {
test('PayloadActionCreator returns correctly typed PayloadAction depending on whether a payload is passed.', () => {
const actionCreator = Object.assign(
(payload?: number) => ({
type: 'action',
payload,
}),
{ type: 'action' },
) as PayloadActionCreator<number | undefined>
expectTypeOf(actionCreator(1)).toEqualTypeOf<
PayloadAction<number | undefined>
>()
expectTypeOf(actionCreator()).toEqualTypeOf<
PayloadAction<number | undefined>
>()
expectTypeOf(actionCreator(undefined)).toEqualTypeOf<
PayloadAction<number | undefined>
>()
expectTypeOf(actionCreator()).not.toMatchTypeOf<PayloadAction<number>>()
expectTypeOf(actionCreator(1)).not.toMatchTypeOf<
PayloadAction<undefined>
>()
})
test('PayloadActionCreator is compatible with ActionCreator.', () => {
const payloadActionCreator = Object.assign(
(payload?: number) => ({
type: 'action',
payload,
}),
{ type: 'action' },
) as PayloadActionCreator
expectTypeOf(payloadActionCreator).toMatchTypeOf<
ActionCreator<UnknownAction>
>()
const payloadActionCreator2 = Object.assign(
(payload?: number) => ({
type: 'action',
payload: payload || 1,
}),
{ type: 'action' },
) as PayloadActionCreator<number>
expectTypeOf(payloadActionCreator2).toMatchTypeOf<
ActionCreator<PayloadAction<number>>
>()
})
})
test('createAction() has type parameter for the action payload.', () => {
const increment = createAction<number, 'increment'>('increment')
expectTypeOf(increment).parameter(0).toBeNumber()
expectTypeOf(increment).parameter(0).not.toBeString()
})
test('createAction() type parameter is required, not inferred (defaults to `void`).', () => {
const increment = createAction('increment')
expectTypeOf(increment).parameter(0).not.toBeNumber()
expectTypeOf(increment().payload).not.toBeNumber()
})
test('createAction().type is a string literal.', () => {
const increment = createAction<number, 'increment'>('increment')
expectTypeOf(increment(1).type).toBeString()
expectTypeOf(increment(1).type).toEqualTypeOf<'increment'>()
expectTypeOf(increment(1).type).not.toMatchTypeOf<'other'>()
expectTypeOf(increment(1).type).not.toBeNumber()
})
test('type still present when using prepareAction', () => {
const strLenAction = createAction('strLen', (payload: string) => ({
payload: payload.length,
}))
expectTypeOf(strLenAction('test').type).toBeString()
})
test('changing payload type with prepareAction', () => {
const strLenAction = createAction('strLen', (payload: string) => ({
payload: payload.length,
}))
expectTypeOf(strLenAction('test').payload).toBeNumber()
expectTypeOf(strLenAction('test').payload).not.toBeString()
expectTypeOf(strLenAction('test')).not.toHaveProperty('error')
})
test('adding metadata with prepareAction', () => {
const strLenMetaAction = createAction('strLenMeta', (payload: string) => ({
payload,
meta: payload.length,
}))
expectTypeOf(strLenMetaAction('test').meta).toBeNumber()
expectTypeOf(strLenMetaAction('test').meta).not.toBeString()
expectTypeOf(strLenMetaAction('test')).not.toHaveProperty('error')
})
test('adding boolean error with prepareAction', () => {
const boolErrorAction = createAction('boolError', (payload: string) => ({
payload,
error: true,
}))
expectTypeOf(boolErrorAction('test').error).toBeBoolean()
expectTypeOf(boolErrorAction('test').error).not.toBeString()
})
test('adding string error with prepareAction', () => {
const strErrorAction = createAction('strError', (payload: string) => ({
payload,
error: 'this is an error',
}))
expectTypeOf(strErrorAction('test').error).toBeString()
expectTypeOf(strErrorAction('test').error).not.toBeBoolean()
})
test('regression test for https://github.com/reduxjs/redux-toolkit/issues/214', () => {
const action = createAction<{ input?: string }>('ACTION')
expectTypeOf(action({ input: '' }).payload.input).toEqualTypeOf<
string | undefined
>()
expectTypeOf(action({ input: '' }).payload.input).not.toBeNumber()
expectTypeOf(action).parameter(0).not.toMatchTypeOf({ input: 3 })
})
test('regression test for https://github.com/reduxjs/redux-toolkit/issues/224', () => {
const oops = createAction('oops', (x: any) => ({
payload: x,
error: x,
meta: x,
}))
expectTypeOf(oops('').payload).toBeAny()
expectTypeOf(oops('').error).toBeAny()
expectTypeOf(oops('').meta).toBeAny()
})
describe('createAction.match()', () => {
test('simple use case', () => {
const actionCreator = createAction<string, 'test'>('test')
const x: Action<string> = {} as any
if (actionCreator.match(x)) {
expectTypeOf(x.type).toEqualTypeOf<'test'>()
expectTypeOf(x.payload).toBeString()
} else {
expectTypeOf(x.type).not.toMatchTypeOf<'test'>()
expectTypeOf(x).not.toHaveProperty('payload')
}
})
test('special case: optional argument', () => {
const actionCreator = createAction<string | undefined, 'test'>('test')
const x: Action<string> = {} as any
if (actionCreator.match(x)) {
expectTypeOf(x.type).toEqualTypeOf<'test'>()
expectTypeOf(x.payload).toEqualTypeOf<string | undefined>()
}
})
test('special case: without argument', () => {
const actionCreator = createAction('test')
const x: Action<string> = {} as any
if (actionCreator.match(x)) {
expectTypeOf(x.type).toEqualTypeOf<'test'>()
expectTypeOf(x.payload).not.toMatchTypeOf<{}>()
}
})
test('special case: with prepareAction', () => {
const actionCreator = createAction('test', () => ({
payload: '',
meta: '',
error: false,
}))
const x: Action<string> = {} as any
if (actionCreator.match(x)) {
expectTypeOf(x.type).toEqualTypeOf<'test'>()
expectTypeOf(x.payload).toBeString()
expectTypeOf(x.meta).toBeString()
expectTypeOf(x.error).toBeBoolean()
expectTypeOf(x.payload).not.toBeNumber()
expectTypeOf(x.meta).not.toBeNumber()
expectTypeOf(x.error).not.toBeNumber()
}
})
test('potential use: as array filter', () => {
const actionCreator = createAction<string, 'test'>('test')
const x: Action<string>[] = []
expectTypeOf(x.filter(actionCreator.match)).toEqualTypeOf<
PayloadAction<string, 'test'>[]
>()
})
})
test('ActionCreatorWithOptionalPayload', () => {
expectTypeOf(createAction<string | undefined>('')).toEqualTypeOf<
ActionCreatorWithOptionalPayload<string | undefined>
>()
expectTypeOf(
createAction<void>(''),
).toEqualTypeOf<ActionCreatorWithoutPayload>()
assertType<ActionCreatorWithNonInferrablePayload>(createAction(''))
expectTypeOf(createAction<string>('')).toEqualTypeOf<
ActionCreatorWithPayload<string>
>()
expectTypeOf(
createAction('', (_: 0) => ({
payload: 1 as 1,
error: 2 as 2,
meta: 3 as 3,
})),
).toEqualTypeOf<ActionCreatorWithPreparedPayload<[0], 1, '', 2, 3>>()
const anyCreator = createAction<any>('')
expectTypeOf(anyCreator).toEqualTypeOf<ActionCreatorWithPayload<any>>()
expectTypeOf(anyCreator({}).payload).toBeAny()
})
test("Verify action creators should not be passed directly as arguments to React event handlers if there shouldn't be a payload", () => {
const emptyAction = createAction<void>('empty/action')
function TestComponent() {
// This typically leads to an error like:
// // A non-serializable value was detected in an action, in the path: `payload`.
// @ts-expect-error Should error because `void` and `MouseEvent` aren't compatible
return <button onClick={emptyAction}>+</button>
}
})
})
|