Cache.remove(options)

Method Description

Removes a value from the cache.

Returns

void

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Governance

1 unit

Module

N/cache Module

Parent Object

cache.Cache

Sibling Object Members

Cache Object Members

Since

2016.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
`options.key`	string	required	The key corresponding to the value to be removed from the cache.

Parameter

Type

Required / Optional

Description

options.key

string

required

The key corresponding to the value to be removed from the cache.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/cache Module Script Samples.

          //Add additional code 
...
var myCache = cache.getCache({
    name: 'temporaryCache',
    scope: cache.Scope.PRIVATE
});
myCache.remove({
    key: 'keyText'
});
...
//Add additional code

Parameters

Syntax

Related Topics