Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation for properties of classes

See original GitHub issue

The docs contain all methods available, but not the properties.

For example, the docs say to retrieve a specific submission with the command:

r.getSubmission('2np694')

However, there is no documentation about how to retrieve the title, score or upvote ratio of the submission.

Issue Analytics

State:
Created 6 years ago
Comments:5 (2 by maintainers)

Top GitHub Comments

1reaction

not-an-aardvarkcommented, Mar 18, 2018

Not that I’m aware of. My recommendation would be to either console.log the object that you’re examining to access its properties, or visit the corresponding URL in your browser (with .json at the end to view the JSON version).

0reactions

SpyTeccommented, Jan 7, 2021

Can this be reopened? The Typescript type definitions include the properties, why not use those to feed the documentation?

No, your issue is for something else so please open a new issue for it. TypeScript definitions do not have the same verbosity for documentation as our JSDoc currently have

Top Results From Across the Web

c# - How to document a class property - Stack Overflow

In this example, the set accessor has been given private access, meaning that it can only be accessed by local members of the...

Properties - C# Programming Guide - Microsoft Learn

Properties enable a class to expose a public way of getting and setting values, while hiding implementation or verification code.

Document classes - IBM

Document classes help you to organize and classify the documents that belong to a case ... You can create as many document classes...

Properties (Java Platform SE 7 ) - Oracle Help Center

The Properties class represents a persistent set of properties. The Properties can be saved to a stream or loaded from a stream.

Classes - JavaScript - MDN Web Docs

Class body · Constructor · Static initialization blocks · Prototype methods · Generator methods · Static methods and fields · Binding this with ......