[Feature]: common > utils > clamp error case

Package Scope

• Add to an existing package
• New package

Package name: @toss/utils

Overview

In clamp.ts

Currently, the function is only supposed to work if bound1 is less than bound2. If user unaware of this rule and can put a larger value in bound1 than bound2. In that case, this function will not function normally. For example, if value=3, bound1=10, bound2=1, the return value must be 3, but the error results in 1.

Describe the solution you’d like

i think this code works well if you agree I will make Pull request

export function clamp(value: number, bound1: number, bound2?: number) {
  if (bound2 == null) {
    return Math.min(value, bound1);
  }

  if (bound1 > bound2) {
    return Math.min(Math.max(value, bound2), bound1);
  }

  return Math.min(Math.max(value, bound1), bound2);
}

Additional context

[raon0211]

Yes, sure!

[raon0211]

I guess this is in fact a bug. However, I think throwing an error early when our assumption (bound1 <= bound2) is broken might be a better approach, rather than returning an arbitrary value. (I think no one intends to write code like clamp(3, 10, 1) 😄 ) What do you think?