libraries/stdlib/js/builtins/Boolean.kt

/*
 * Copyright 2010-2024 JetBrains s.r.o. and Kotlin Programming Language contributors.
 * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
 */

// Auto-generated file. DO NOT EDIT!
// Generated by org.jetbrains.kotlin.generators.builtins.numbers.primitives.JsBooleanGenerator

@file:Suppress("NON_ABSTRACT_FUNCTION_WITH_NO_BODY", "UNUSED_PARAMETER")

package kotlin

/** Represents a value which is either `true` or `false`. */
public actual class Boolean private constructor() : Comparable<Boolean> {
    @SinceKotlin("1.3")
    public actual companion object {}

    /** Returns the inverse of this boolean. */
    @kotlin.internal.IntrinsicConstEvaluation
    public actual operator fun not(): Boolean

    /**
     * Performs a logical `and` operation between this Boolean and the [other] one. Unlike the `&&` operator,
     * this function does not perform short-circuit evaluation. Both `this` and [other] will always be evaluated.
     */
    @kotlin.internal.IntrinsicConstEvaluation
    public actual infix fun and(other: Boolean): Boolean

    /**
     * Performs a logical `or` operation between this Boolean and the [other] one. Unlike the `||` operator,
     * this function does not perform short-circuit evaluation. Both `this` and [other] will always be evaluated.
     */
    @kotlin.internal.IntrinsicConstEvaluation
    public actual infix fun or(other: Boolean): Boolean

    /** Performs a logical `xor` operation between this Boolean and the [other] one. */
    @kotlin.internal.IntrinsicConstEvaluation
    public actual infix fun xor(other: Boolean): Boolean

    /**
     * Compares this [Boolean] with the specified [Boolean][other] for order. Returns zero if both are equal to each other,
     * a negative number if [this][Boolean] is `false` and [other] is `true`,
     * or a positive number if [this][Boolean] is `true` and [other] is `false`.
     *
     * In other words, `false` is considered to be "less than" `true`.
     *
     * @sample samples.misc.BooleanSamples.compareTo
     */
    @kotlin.internal.IntrinsicConstEvaluation
    public actual override fun compareTo(other: Boolean): Int

    @kotlin.internal.IntrinsicConstEvaluation
    public actual override fun toString(): String

    @kotlin.internal.IntrinsicConstEvaluation
    public actual override fun equals(other: Any?): Boolean

    public actual override fun hashCode(): Int
}