microsoft / microsoft/TypeScript

String key-value type in basic types

Open
#32,739 4 comments 0 reactions 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

typescript string key value type

Suggestion

Add an extra heavely used type - simple Object with string keys, used a lot as "primitive Map".
Tired writing { [ key: string ]: T } each time.
Want export type StrMap<T> = { [ key: string ]: T }; as one of basic types.
Keys in Objects are not too far from strings ( Object.keys(_object).join('/') ).
This is not fully related to https://github.com/microsoft/TypeScript/pull/26797 as it's a wider use case, IMHO.

Use Cases

I'm using this type in a numerous projects in numerous modules.

Examples

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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 implementation files, tests, or entry points are named in the issue. Begin by reviewing how TypeScript represents reusable object index-signature types and the linked discussion in PR #26797; the work is complete only when the project decides whether a built-in generic string-keyed type belongs in the language and defines its intended 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
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.