[Content]: Alias doc

[matthew-dean]

What article on segment.com/docs is affected?

https://segment.com/docs/connections/spec/alias/

What part(s) of the article would you like to see updated?

The alias page doesn't make it clear at all which order the function arguments come in. It maybe sorta implies that it's alias(previousId, newId) is the order of arguments, but it isn't demonstrated in an example.

Furthermore, in the TypeScript types, it labels the first argument as to and the second argument as from but what the heck does that mean? I would assume that from is previousId implying that the order of arguments is alias(newId, previousId), but which is it? Can you not just label the arguments previousId / newId in an example? Or does the order of arguments not matter?

Additional information

No response

[matthew-dean]

I've now re-read the documentation many times. It still doesn't make sense.

In the documentation, it gives an example with a userId of 507f191e81 and a previousId of jen@email.com.

Then, it demonstrates passing in analytics.alias("507f191e81") meaning the newId is the one and only argument.

But then, immediately in the table following, it not only lists the order of arguments as previousId / userId, but it says that previousId is required and userId is optional.

Therefore, we have one example where the order is: userId / previousId, which demonstrates previousId as being optional.

Then we have a second example where the order is previousId / userId which demonstrates userId as being optional.

[matthew-dean]

oh! A teammate sent a page that articulates exactly what I'm asking for. Maybe these docs could be merged? https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#alias

[github-actions]

This issue is stale because it has been open 60 days with no activity.