#docs #articles #best-practices
How to name your signal types
Should you give your signal types a simple name, or use a more complex naming scheme? We'll help you decide.
When you send a signal, you’ll always have to tell TelemetryDeck what type of signal you want to send. Type is just a String, so in theory you could add anything in there. Your type could be
This sentence no verb or even
Single word types
If you’re just hacking with TelemetryDeck, consider using a single word for your type. It’s easy to type, and as long as your app is not too big, it’s easy to find the signal type you’re looking for.
Paths in Dot Notation
What many of our customers do (and we ourselves internally as well) is using a dot notation that represents the path of an action or event inside the app.
Here are some examples:
We recommend you don’t make the paths too specific or deeper than, say, 3 levels. Otherwise you’ll run into annoying mismatches when you move a feature around but can’t really rename the insight type to match.
Distinguishing between views, actions and events
If you want to distinguish between views, actions and events, or just views and actions, you can add that to the type, such as
InsightEditor.MetaEditor.actions.SaveInsight. However, I personally don’t get much value from that. Instead, I usually annotate types implicitly using grammar:
- Present tense compount Verbs are actions:
- Anything in past tense is a view or an event:
Don’t be afraid to play around a bit and find out what works best for you!