Error when importing Redis client into Typescript app

Question

When importing the npm Redis module into a TypeScript application, I receive the error:

node_modules/@node-redis/client/dist/lib/client/index.d.ts:45:78 - error TS1256: A rest element must be last in a tuple type.
45 export declare type ClientLegacyCommandArguments = LegacyCommandArguments | [...LegacyCommandArguments, ClientLegacyCallback];

The error is from the import statement in my redis.ts file:

import { createClient } from 'redis';

class RedisCache {
    private client: any;

    async init() {

        const client = createClient();

        client.on('error', (err) => console.log('Redis Client Error', err));

        await client.connect();

        await client.set('key', 'value');
        const value = await client.get('key');
        console.log(value);
    }
}

const reditCache = new RedisCache();

export default reditCache;

Here is a subset of the dependencies from the package.json file:

{
    "dependencies": {
        "express": "4.17.1",
        "passport": "0.4.1",
        "passport-jwt": "^4.0.0",
        "redis": "^4.0.1",
        "typescript": "4.1.3"
    }
}

tsconfig.json:

{
    "compilerOptions": {
        "module": "commonjs",
        "esModuleInterop": true,
        "allowSyntheticDefaultImports": true,
        "target": "es6",
        "noImplicitAny": true,
        "moduleResolution": "node",
        "sourceMap": true,
        "outDir": "dist",
        "baseUrl": ".",
        "resolveJsonModule": true,
        "paths": {
            "*": [
                "node_modules/*",
                "src/types/*"
            ]
        }
    },
    "include": [
        "src/**/*",
        "src/locales/*.json",
    ]
}

I've tried adding the types package (@types/redis) but the error still shows. This seems to be an issue with the Redis module and TypeScript. Has anyone had experience with this error before? Thanks in advance for any help.

It's possible the latest version of the Redis module isn't ready for TypeScript, it's only a few months old at this time. Downgrading to an older version is working. — MichaelG
– MichaelG, Commented Jan 10, 2022 at 16:46

steve · Accepted Answer · 2022-03-05 02:45:12Z

2

Your code works on node14 if you remove the any type. My package.json uses:

"@tsconfig/node14": "^1.0.1",
"redis": "^4.0.4"

class RedisCache {
    //private client: any;

    async init() {

        const client = createClient();

        client.on('error', (err) => console.log('Redis Client Error', err));

        await client.connect();

        await client.set('key', 'value');
        const value = await client.get('key');
        console.log("In class");
        console.log(value);
    }
}

const reditCache = new RedisCache();
reditCache.init();

answered Mar 5, 2022 at 2:45

steve

212 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

As Md Habibullah Over a year ago

good answer, I like it...

Leibale Eidelman · Accepted Answer · 2022-01-11 14:04:56Z

0

@MichaelG node-redis v4 works with TypeScript v4 and up, try to upgrade your TypeScript engine

answered Jan 11, 2022 at 14:04

Leibale Eidelman

3,2951 gold badge20 silver badges31 bronze badges

1 Comment

MichaelG Over a year ago

Thanks for the response Leibale, I'm running TypeScript version 4.1.3. I've updated the question to include this information in the package.json file.

Collectives™ on Stack Overflow

Error when importing Redis client into Typescript app

2 Answers 2

1 Comment

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related