nodes/generated

Interface RedisNodeParameters

Source


interface RedisNodeParameters {
    channel?: string;
    expire?: boolean;
    getValues?: boolean;
    key?: string;
    keyPattern?: string;
    keyType?:
        | "string"
        | "list"
        | "automatic"
        | "hash"
        | "sets";
    list?: string;
    messageData?: string;
    operation?: | "get"
    | "delete"
    | "publish"
    | "push"
    | "set"
    | "incr"
    | "info"
    | "keys"
    | "llen"
    | "pop";
    options?: { dotNotation?: boolean };
    propertyName?: string;
    tail?: boolean;
    ttl?: number;
    value?: string;
    valueIsJSON?: boolean;
}

Properties§

§readonly channel?: string

Channel name

§readonly expire?: boolean

Whether to set a timeout on key

§readonly getValues?: boolean

Whether to get the value of matching keys Default: true

§readonly key?: string

Name of the key to delete from Redis

§readonly keyPattern?: string

The key pattern for the keys to return

§readonly keyType?: "string" | "list" | "automatic" | "hash" | "sets"

The type of the key to get Default: "automatic"

§readonly list?: string

Name of the list in Redis

§readonly messageData?: string

Data to publish

§readonly operation?:
    | "get"
    | "delete"
    | "publish"
    | "push"
    | "set"
    | "incr"
    | "info"
    | "keys"
    | "llen"
    | "pop"

Default: "info"

§readonly options?: { ... }

Default: {}

§readonly propertyName?: string

Name of the property to write received data to. Supports dot-notation. Example: "data.person[0].name". Default: "propertyName"

§readonly tail?: boolean

Whether to push or pop data from the end of the list

§readonly ttl?: number

Number of seconds before key expiration Default: 60 Type options: {"minValue":1}

§readonly value?: string

The value to write in Redis

§readonly valueIsJSON?: boolean

Whether the value is JSON or key value pairs Default: true