/*@jsxRuntime automatic @jsxImportSource react*/ const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; const tableOfContents = [{ "title": "Arguments", "slug": "arguments", "depth": 2, "children": [] }, { "title": "Response", "slug": "response", "depth": 2, "children": [] }]; const userDefinedExamples = { "request": { "type": "RequestExample", "children": [{ "filename": "Basic", "html": "

await redis.set(\"my-key\", {my: \"value\"});\n

" }, { "filename": "Expire in 60 seconds", "html": "

await redis.set(\"my-key\", {my: \"value\"}, {\n  ex: 60\n});\n

" }, { "filename": "Only update", "html": "

await redis.set(\"my-key\", {my: \"value\"}, {\n  xx: true\n});\n

" }] } }; const endpoint = undefined; const MDXLayout = props => { const {MDXContentController} = _provideComponents(); if (!MDXContentController) _missingMdxReference("MDXContentController", true); return _jsx(MDXContentController, Object.assign({}, props, { tableOfContents: tableOfContents, userDefinedExamples: userDefinedExamples, endpoint: endpoint, pageMetadata: pageMetadata, children: props.children })); }; function _createMdxContent(props) { const _components = Object.assign({ p: "p", code: "code" }, _provideComponents(), props.components), {Heading, ParamField, Expandable, ResponseField} = _components; if (!Expandable) _missingMdxReference("Expandable", true); if (!Heading) _missingMdxReference("Heading", true); if (!ParamField) _missingMdxReference("ParamField", true); if (!ResponseField) _missingMdxReference("ResponseField", true); return _jsxs(_Fragment, { children: [_jsx(Heading, { level: "2", id: "arguments", children: "Arguments" }), "\n", _jsx(ParamField, { body: "key", type: "string", required: true, children: _jsx(_components.p, { children: "The key" }) }), "\n", _jsx(ParamField, { body: "value", type: "TValue", required: true, children: _jsxs(_components.p, { children: ["The value, if this is not a string, we will use ", _jsx(_components.code, { children: "JSON.stringify" }), " to convert it\nto a string."] }) }), "\n", _jsxs(ParamField, { body: "opts", type: "object", children: [_jsx(_components.p, { children: "You can pass a few options to the command." }), _jsxs(Expandable, { children: [_jsx(ParamField, { body: "get", type: "boolean", children: _jsxs(_components.p, { children: ["Instead of returning ", _jsx(_components.code, { children: "\"OK\"" }), ", this will cause the command to return the old\nvalue stored at key, or ", _jsx(_components.code, { children: "null" }), " when key did not exist."] }) }), _jsx(ParamField, { body: "ex", type: "integer", children: _jsx(_components.p, { children: "Adds an expiration (in seconds) to the key." }) }), _jsx(ParamField, { body: "px", type: "integer", children: _jsx(_components.p, { children: "Adds an expiration (in milliseconds) to the key." }) }), _jsx(ParamField, { body: "exat", type: "integer", children: _jsx(_components.p, { children: "Expires the key after the given timestamp (in seconds)." }) }), _jsx(ParamField, { body: "pxat", type: "integer", children: _jsx(_components.p, { children: "Expires the key after the given timestamp (in milliseconds)." }) }), _jsx(ParamField, { body: "keepTtl", type: "boolean", children: _jsx(_components.p, { children: "Keeps the old expiration if the key already exists." }) }), _jsx(ParamField, { body: "nx", type: "boolean", children: _jsx(_components.p, { children: "Only set the key if it does not already exist." }) }), _jsx(ParamField, { body: "xx", type: "boolean", children: _jsx(_components.p, { children: "Only set the key if it already exists." }) })] })] }), "\n", _jsx(Heading, { level: "2", id: "response", children: "Response" }), "\n", _jsx(ResponseField, { required: true, children: _jsx(_components.p, { children: _jsx(_components.code, { children: "\"OK\"" }) }) })] }); } function MDXContent(props = {}) { return _jsx(MDXLayout, Object.assign({}, props, { children: _jsx(_createMdxContent, props) })); } return { tableOfContents, userDefinedExamples, endpoint, default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }

Overall

SDKs

DevOps

​Arguments

​Response

Arguments

Response