adobe/adobe-client-data-layer

Provide type definition for TypeScript

Open

#99 opened on Sep 1, 2020

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)JavaScript (27 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (122 stars)
PR merge metrics
 (PR metrics pending)

Description

Not a bug, but a feature request: Many front end developers nowadays write their scripting code in TypeScript instead of JavaScript. It would be great if this project would provide type definitions for the data-layer object.

Even better would be, if it would be possible to just import it in any .ts file and use it directly as an object without relying on the window object. Because like this we can make sure the object is there as it will be in the same transpiled js file and we don't need the [] fallback.

Contributor guide

Research direction
Examine the existing data layer structure and create TypeScript declaration files (.d.ts). Additionally, modify the module exports to allow direct import without relying on the window object.
Tech stack
javascripttypescript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75