microsoft / microsoft/TypeScript

Cannot assign readonly statics in static blocks

Open
#56,584 4 comments 1 reaction 1 assignee View on GitHub

@rbuckton is already working on this.

Since Nov 29, 2023.

Needs Investigation
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔍 Search Terms

"assign readonly static in static block", "assign readonly static in static constructor"

✅ Viability Checklist
⭐ Suggestion

static readonly fields should be assignable within static code blocks, similar to how readonly fields are assignable in constructors. I've had a read through various issues, and those around the MR that introduced support for static blocks, but found no mention of dealing with readonly fields.

📃 Motivating Example

I'm making a variation on ringbufferjs, here, this.headerSize = ... shows an error without the //@ts-expect-error

type TypedArray =
  | Float32Array
  | Float64Array
  | Int8Array
  | Int16Array
  | Int32Array
  | BigInt64Array;
type TypedArrayConstructor =
  | Float32ArrayConstructor
  | Float64ArrayConstructor
  | Int8ArrayConstructor
  | Int16ArrayConstructor
  | Int32ArrayConstructor
  | BigInt64ArrayConstructor;

export default class LiveRingBuffer {
  private static readonly headerSize: number;

  static {
    const writePtrWidth = Uint32Array.BYTES_PER_ELEMENT;
    const readPtrWidth = Uint32Array.BYTES_PER_ELEMENT;
    const lapPtrWidth = Uint32Array.BYTES_PER_ELEMENT;
    //@ts-expect-error
    this.headerSize = writePtrWidth + readPtrWidth + lapPtrWidth;
  }

  static getStorageForCapacity(
    capacity: number,
    type: TypedArrayConstructor,
  ): SharedArrayBuffer {
    if (!type.BYTES_PER_ELEMENT) {
      throw TypeError('Pass in a ArrayBuffer subclass');
    }
    const storageWidth = (capacity + 1) * type.BYTES_PER_ELEMENT;
    const alignedHeaderWidth =
      Math.ceil(this.headerSize / type.BYTES_PER_ELEMENT) *
      type.BYTES_PER_ELEMENT;

    const bytes = alignedHeaderWidth + storageWidth;
    return new SharedArrayBuffer(bytes);
  }

  // ...
}
💻 Use Cases
  1. What do you want to use this for?
    See "Motivating Example"
  2. What shortcomings exist with current approaches?
    Current approach suppresses readonly error; alternative is to remove the readonly keyword, also not ideal since it really is readonly/const
  3. What workarounds are you using in the meantime?
    //@ts-expect-error hides the error and emits the desired code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.