Issue #313 document terminal constructor

[parisk]

Document the options of the terminal constructor.

Closes #313 in combination with xtermjs/xtermjs.org#5.

[blink1073]

Are these intended to be the supported options for get/setOption as well?

[parisk]

@blink1073 definitely. Whatever option is supported in the constructor should be supported in getOption and setOption as well.

[Tyriar]

@parisk geometry/cols/rows would need special handling in setOption to keep them in sync.

[parisk]

Let's put geometry out of the equation to keep this simple.

[blink1073]

Perhaps a note in get/setOption pointing to the constructor options then?

[blink1073]

And does this mean that the rest of Terminal.defaults are not part of the public API?

[parisk]

@blink1073 only what is documented in http://xtermjs.org/docs/ should be considered part of the public API.

[blink1073]

Thank you for clarifying. I ask because I wrote the TypeScript type declarations file for xterm on DefinitelyTyped, and will update it once the options are finalized.

[parisk]

Ping @Tyriar for a code review, when it's OK for you.

[takluyver]

Thanks :-)

[parisk]

What about leaving geometry out of the equation?

On Sun, 23 Oct 2016 at 17:33, Daniel Imms [email protected] wrote:

@parisk https://github.com/parisk geometry/cols/rows would need special
handling in setOption to keep them in sync.

—
You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub
#321 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ABIi8L0vwUEGR0sMNQ2p4Z3niiSE15IKks5q23BVgaJpZM4KeJHS
.

Paris Kasidiaris
CEO

SourceLair, Private Company
www.sourcelair.com