react Architecture Docs
Home / Function/ isKnownMutableEffect() — react Function Reference

isKnownMutableEffect() — react Function Reference

Architecture documentation for the isKnownMutableEffect() function in InferMutationAliasingEffects.ts from the react codebase.

Function typescript BabelCompiler Validation calls 2 called by 1

Entity Profile

Dependency Diagram

graph TD
  2ac23db5_db05_5656_41fc_d176ddafebe2["isKnownMutableEffect()"]
  d24875c3_c045_4414_2cc9_16f96d59c629["InferMutationAliasingEffects.ts"]
  2ac23db5_db05_5656_41fc_d176ddafebe2 -->|defined in| d24875c3_c045_4414_2cc9_16f96d59c629
  10386ad8_f999_3e46_b390_aba6afce2aec["areArgumentsImmutableAndNonMutating()"]
  10386ad8_f999_3e46_b390_aba6afce2aec -->|calls| 2ac23db5_db05_5656_41fc_d176ddafebe2
  041ca752_10c1_3cda_1f5c_02f44a01310e["invariant()"]
  2ac23db5_db05_5656_41fc_d176ddafebe2 -->|calls| 041ca752_10c1_3cda_1f5c_02f44a01310e
  d7fde76c_4fd9_feb3_299b_798689f05bc6["assertExhaustive()"]
  2ac23db5_db05_5656_41fc_d176ddafebe2 -->|calls| d7fde76c_4fd9_feb3_299b_798689f05bc6
  style 2ac23db5_db05_5656_41fc_d176ddafebe2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingEffects.ts lines 2850–2874

export function isKnownMutableEffect(effect: Effect): boolean {
  switch (effect) {
    case Effect.Store:
    case Effect.ConditionallyMutate:
    case Effect.ConditionallyMutateIterator:
    case Effect.Mutate: {
      return true;
    }

    case Effect.Unknown: {
      CompilerError.invariant(false, {
        reason: 'Unexpected unknown effect',
        loc: GeneratedSource,
      });
    }
    case Effect.Read:
    case Effect.Capture:
    case Effect.Freeze: {
      return false;
    }
    default: {
      assertExhaustive(effect, `Unexpected effect \`${effect}\``);
    }
  }
}

Domain

Subdomains

Defined In

Calls

Called By

Source

Frequently Asked Questions

What does isKnownMutableEffect() do?
isKnownMutableEffect() is a function in the react codebase, defined in compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingEffects.ts.
Where is isKnownMutableEffect() defined?
isKnownMutableEffect() is defined in compiler/packages/babel-plugin-react-compiler/src/Inference/InferMutationAliasingEffects.ts at line 2850.
What does isKnownMutableEffect() call?
isKnownMutableEffect() calls 2 function(s): assertExhaustive, invariant.
What calls isKnownMutableEffect()?
isKnownMutableEffect() is called by 1 function(s): areArgumentsImmutableAndNonMutating.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free