microsoft / microsoft/TypeScript

[suggest] constructor init delegation with "strictPropertyInitialization"

Open
#59,997 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

🔍 Search Terms

strictPropertyInitialization, Property has no initializer and is not definitely assigned in the constructor.

✅ Viability Checklist
⭐ Suggestion

Hello, have you ever considered adding a special hack to delegate the role of a class constructor when using strictPropertyInitialization: true in the tsconfig file?

In fact, I have an issue with an architecture that makes the constructor unnecessary until the class is injected into a facade that activates the system and creates the private dependencies of the class.

There is no other solution except to disable this rule, which is frankly not great and very limiting when a project uses several design patterns requiring a distinct approach.
To take advantage of the security of strictPropertyInitialization, would it be possible to have maybe a special utility type that tells TypeScript to check this method instead of the constructor?

Here are examples that could potentially be good solutions:
I personally prefer examples 2 and 3.
The first example can bring more complexity


📃 Motivating Example

Suggest 1: method with special type

We add methodname( this:ThisConstructor )

class SystemA {
	public readonly instanceNeedDependancyAvaibleLater: object; // Property 'instanceNeedDependancyAvaibleLater' has no initializer and is not definitely assigned in the constructor.

	constructor() {
	}

	// ThisConstructor can be a special type flag thas tell to tsserveur with "strictPropertyInitialization" to ignore the constructor and scan asignation in this method instead
	init( this:ThisConstructor ) {
		this.instanceNeedDependancyAvaibleLater = {};
	}
}

issues:

  • can add complexity
  • can add perf issue with ts (need scan all method)
  • issue with 2 or more !
  • may have issue with overload

Suggest 2: detect with illegal this in constructor.
It is currently illegal to use "this" in the constructor.
We could take this opportunity to tell ts to check another methods for props initialisation.
I using "string" here, but is juste for give the idea.

class SystemA {
	public readonly instanceNeedDependancyAvaibleLater: object; // Property 'instanceNeedDependancyAvaibleLater' has no initializer and is not definitely assigned in the constructor.

	//  this:'methodName' can maybe tell ts to find this method and scan assignation instead use this constructor
	constructor( this:'init' ) {
	}

	init( ) {
		this.instanceNeedDependancyAvaibleLater = {};
	}
}

issues:

  • will maybe not work with protected and private method based ont how ts work
  • rename or security issue if using "string", ts will need index the token or suggest types
  • add complexity in constructor arguments
  • issue if we extends class with constructor params "need implement"

Suggest 3: using comment

class SystemA {
	public readonly instanceNeedDependancyAvaibleLater: object; // Property 'instanceNeedDependancyAvaibleLater' has no initializer and is not definitely assigned in the constructor.

	//  using a comment flag to scan .init method instead of constructor
	//@ts-strictPropertyInitialization {SystemA.prototype.init}
	constructor( ) {
	}

	init( ) {
		this.instanceNeedDependancyAvaibleLater = {};
	}
}

issues:

  • will maybe not work with protected and private method based ont how ts work
  • It may be perceived and treated incorrectly as a comment, which adds ambiguity:
    • Is it a comment or an instruction essential to the execution of the code? This comment therefore guides the interpretation of the code?

Suggest 4: tracking the flow from constructor:
https://github.com/microsoft/TypeScript/issues/32194
https://github.com/microsoft/TypeScript/issues/30462

class SystemA {
	public readonly instanceNeedDependancyAvaibleLater: object; // Property 'instanceNeedDependancyAvaibleLater' has no initializer and is not definitely assigned in the constructor.

	constructor() {
		this.init();
	}

	// ThisConstructor can be a special type flag thas tell to tsserveur with "strictPropertyInitialization" to ignore the constructor and scan asignation in this method instead
	init() {
		this.instanceNeedDependancyAvaibleLater = {};
	}

issues:

  • can add perf issue with ts (need scan all method and what they do)
  • can add complexity with multiple methods: who, why do assignments
  • it maybe a breakchange
💻 Use Cases
  1. What do you want to use this for?
    This is to address the need for an architecture that requires initialization after adding a loosely coupled facade.
    The idea is to maintain the security of declarations, which current solutions do not allow.
    This approach can also open the door to design patterns that are difficult to manage with TypeScript.

  2. What shortcomings exist with current approaches?
    Currently, there are various tricks that do not allow to maintain the security and philosophy of TypeScript.
    1: //@ts-ignore
    2: public props!:object
    3: strictPropertyInitialization:false

  3. What workarounds are you using in the meantime?
    public props!:object

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.

Research direction

No source files, tests, or compiler entry points are named. Start by reviewing strictPropertyInitialization and the linked issues #32194 and #30462; done would require a settled design for delegated initialization and corresponding TypeScript behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.