290 doc js classes by evolvingkid · Pull Request #333 · Planet-NULLCAST/curriculum

evolvingkid · 2021-10-30T12:46:15Z

Pull Request Template

Description

Add a new content for JavaScript. The content is about classes in JavaScript.
The changes are with the issues #290

How Has This Been Tested?

Tested with simple qa testing doing the test case.

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules
I have checked my code and corrected any misspellings

all docs about jus class added

added test cases to the js class doc

the test casses where missing a line

because their is another chap with 14 and 15

misuvi · 2021-12-06T21:00:27Z

+]
+---
+
+A javascript class is a blueprint for creating objects. A class encapsulates data and functions that manipulate data.


class wrapped in backtick(``) which makes it inline code block. All technical terms need to be wrapped in inline code block

misuvi · 2021-12-06T21:00:56Z

+
+## Class Declaration
+
+We can declare a class by using the class keyword. For example: 


inline code block for 'class'

misuvi · 2021-12-06T21:01:31Z

+
+```
+
+In the above example, the TestClass is the class and `let textClassObject = new TestClass();` is where the we create an object named textClassObject for the TestClass.


inline code block for 'TestClass', 'textClassObject'

misuvi · 2021-12-06T21:01:54Z

+
+In the above example, the TestClass is the class and `let textClassObject = new TestClass();` is where the we create an object named textClassObject for the TestClass.
+
+You can see there is a new keyword used on creating the object of the class. It is used to create a new instance of the TextClass.


TextClass inline code block

misuvi · 2021-12-06T21:02:22Z

+```
+
+## Constructor
+The constructor method is a special method inside the class for creating and initializing an object in a class. Javascript automatically calls the constructor method when you initialize an object of the class.


constructor in inline code block

misuvi · 2021-12-06T21:02:52Z

+
+```
+
+The constructor will be called when you created the object named **textClassObjects**.


inline code block instead of bold

misuvi · 2021-12-06T21:03:26Z

+* Please note that you can only create one constructor in a class.
+***
+### this keyword
+In JavaScript this keyword refers to the object it belongs to.


'this' in inline code block

misuvi · 2021-12-06T21:03:45Z

+### this keyword
+In JavaScript this keyword refers to the object it belongs to.
+
+We will have some examples of **this** in **classes**.


Replace bold with inline codeblock

misuvi · 2021-12-06T21:04:10Z

+let textClassObjects = new TestClass('Ducks');
+
+```
+In the above example, 'this.name' is used to access the name variable on the class named 'TestClass'. And the 'name' variable is the same variable we need as params in our constructor.


instead of single quotes, inline code block

misuvi · 2021-12-06T21:04:37Z

+* Please note that they are actually called methods not variables. But for the simple understanding we just called them variables.
+***
+## Methods
+Just like we use variables and constructor in our class. We can also create functions too. We called then methods. They looks like a function and act like one for the most part.


methods in inline code block

misuvi · 2021-12-06T21:05:16Z

+
+```
+
+In the above example, we create a class and it has a method named toConcatStrings. In the constructor of that class, you can see we have a param named name and we initialize that value to this.stringOne. But if you take look at the class you can see we didn't declare any variables or method named stringOne. Don't worry it will not cause an error a new method named stringOne will be created for our class.


toConcatStrings, this.stringOne, stringOne

misuvi · 2021-12-06T21:05:39Z

+
+In the above example, we create a class and it has a method named toConcatStrings. In the constructor of that class, you can see we have a param named name and we initialize that value to this.stringOne. But if you take look at the class you can see we didn't declare any variables or method named stringOne. Don't worry it will not cause an error a new method named stringOne will be created for our class.
+
+You can see we called our method outside of our class by `const concatData = textClassObjects.toConcatStrings(' Ducks')`. By this, we can point out that we can call the method named **toConcatStrings** on the class **textClassObjects**.


replace *** with `

misuvi · 2021-12-06T21:07:33Z

+      case: ["class Calcu {"],
+      hint: "Please re check the class syntax and code formatting.",
+      isCorrect: false
+    },


hint should be like 'Create a class named Calcu', 'add constructor to the class with param num1', 'assign num1 to class property num1'. If you run testcases in the UI, you'll know why.

misuvi · 2021-12-06T21:07:51Z

+    },
+     {
+      id: 2,
+      case: ["constructor(num1){"],


insert space after ')'

misuvi · 2021-12-06T21:08:04Z

+    },
+     {
+      id: 3,
+      case: ["this.num1 = num1;"],


add case without semicolon

misuvi · 2021-12-06T21:08:24Z

+    },
+    {
+      id: 6,
+      case: ["return this.num1 + num2;"],


case without semicolon

misuvi · 2021-12-06T21:08:41Z

+    },
+    {
+      id: 9,
+      case: ["let calcuObjects = new Calcu(1);"],


case without semicolon

misuvi · 2021-12-06T21:08:52Z

+    },
+     {
+      id: 10,
+      case: ["const calcuNum2 = calcuObjects.toAdd(2);"],


case without semicolon

misuvi · 2021-12-06T21:09:05Z

+    },
+    {
+      id: 11,
+      case: ["console.log(concatData);"],


case without semicolon

misuvi · 2021-12-06T21:10:27Z

+You can see we called our method outside of our class by `const concatData = textClassObjects.toConcatStrings(' Ducks')`. By this, we can point out that we can call the method named **toConcatStrings** on the class **textClassObjects**.
+
+## Complete the task below
+- create a class named Calcu


Calcu,, num1 inline code blocks

misuvi · 2021-12-06T21:12:48Z

+## Complete the task below
+- create a class named Calcu
+- create a constructor with params as num1
+- make an object name num1 using this keyword and insert the above num1 param to it.


this particular task is ambiguous. Maybe Object property instead of object name, wrap num1 in backticks, and replace 'insert' with 'assign'

misuvi · 2021-12-06T21:14:34Z

+- create a class named Calcu
+- create a constructor with params as num1
+- make an object name num1 using this keyword and insert the above num1 param to it.
+- make a method name toAdd which have a param named num2


~~name~~ named, toAdd as inline code block, ~~'which have a'~~ Which accepts a, num2 in inline code block

misuvi · 2021-12-06T21:14:52Z

+- create a constructor with params as num1
+- make an object name num1 using this keyword and insert the above num1 param to it.
+- make a method name toAdd which have a param named num2
+- it should return the the addition of method num1 and num2 from the param.


num1 num2 in backticks

misuvi · 2021-12-06T21:15:07Z

+- make an object name num1 using this keyword and insert the above num1 param to it.
+- make a method name toAdd which have a param named num2
+- it should return the the addition of method num1 and num2 from the param.
+- create an object named calcuObjects of the above class and pass value as 1.


calcuObjects

Also suggest 'using let', where let is inline code block

misuvi · 2021-12-06T21:16:32Z

+- make a method name toAdd which have a param named num2
+- it should return the the addition of method num1 and num2 from the param.
+- create an object named calcuObjects of the above class and pass value as 1.
+- now call the method toAdd and pass value as 2 and get the return value to a variable named calcuNum2


toAdd, 2, calcuNum2 in inline code blocks, suggest 'using const', const in inline code block

misuvi

Please make the necessary changes

evolvingkid added 4 commits October 30, 2021 13:21

doc: class in js Planet-NULLCAST#290

2d682d8

all docs about jus class added

doc: test case done Planet-NULLCAST#290

621c398

added test cases to the js class doc

fix: test case of js class

e67fed0

the test casses where missing a line

fix: chap id is been updated to 16

702ec2b

because their is another chap with 14 and 15

thealpha93 requested a review from misuvi October 30, 2021 15:54

misuvi reviewed Dec 6, 2021

View reviewed changes

Comment thread courses/javascript/classes.md

},

{

id: 2,

case: ["constructor(num1){"],

misuvi Dec 6, 2021

Copy link
Copy Markdown

Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

insert space after ')'

misuvi reviewed Dec 6, 2021

View reviewed changes

Comment thread courses/javascript/classes.md

},

{

id: 3,

case: ["this.num1 = num1;"],

misuvi Dec 6, 2021

Copy link
Copy Markdown

Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add case without semicolon

misuvi reviewed Dec 6, 2021

View reviewed changes

misuvi requested changes Dec 6, 2021

View reviewed changes


		## Class Declaration

		We can declare a class by using the class keyword. For example:


		```

		In the above example, the TestClass is the class and `let textClassObject = new TestClass();` is where the we create an object named textClassObject for the TestClass.


		In the above example, the TestClass is the class and `let textClassObject = new TestClass();` is where the we create an object named textClassObject for the TestClass.

		You can see there is a new keyword used on creating the object of the class. It is used to create a new instance of the TextClass.


		```

		The constructor will be called when you created the object named textClassObjects.


		```

		In the above example, we create a class and it has a method named toConcatStrings. In the constructor of that class, you can see we have a param named name and we initialize that value to this.stringOne. But if you take look at the class you can see we didn't declare any variables or method named stringOne. Don't worry it will not cause an error a new method named stringOne will be created for our class.


		In the above example, we create a class and it has a method named toConcatStrings. In the constructor of that class, you can see we have a param named name and we initialize that value to this.stringOne. But if you take look at the class you can see we didn't declare any variables or method named stringOne. Don't worry it will not cause an error a new method named stringOne will be created for our class.

		You can see we called our method outside of our class by `const concatData = textClassObjects.toConcatStrings(' Ducks')`. By this, we can point out that we can call the method named toConcatStrings on the class textClassObjects.

Uh oh!

Conversation

evolvingkid commented Oct 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Template

Description

How Has This Been Tested?

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

misuvi Dec 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

misuvi left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

evolvingkid commented Oct 30, 2021 •

edited

Loading

misuvi Dec 6, 2021 •

edited

Loading