Whatever message this page gives is out now! Go check it out!

remove

Last update:
May 18, 2026
Removes an element from the set.

Description

Removes an element from a set.

Returns

Boolean.

Category

ColdFusion Set member methods

Function syntax

set.remove(element)

Parameters

ParameterDescription
elementElement to remove.

See also

Example

The following example uses this API in cfscript (syntax: set.remove(element)).

<cfscript>
    s = setNew();
    s.add("x");
    s.add("y");
    removed = s.remove("x");
    writeOutput(removed); // true
    deleted=s.delete("x");
    writeOutput(deleted); // error on undefined
</cfscript>   
      

Real-world example

Real-world example: one-time API tokens (allowlist + remove boolean)

<cfscript>
    // In-memory allowlist (use Redis or DB in production for clustering)
    allowedTokens = setNew();

    function issueToken(required string rawToken) {
        allowedTokens.add(rawToken);
    }

    function consumeToken(required string presentedToken) {
        var removed = allowedTokens.remove(presentedToken);
        if (removed) {
            return { "ok": true, "reason": "consumed" };
        }
        return { "ok": false, "reason": "invalid_or_replay" };
    }

    issueToken("one-time-7f3a9c");
    writeOutput(serializeJSON(consumeToken("one-time-7f3a9c"))); // ok true — first use
    writeOutput(serializeJSON(consumeToken("one-time-7f3a9c"))); // ok false — replay
</cfscript>      
      

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page