Michael Hladky BioPhoton

Deprecations and their breaking change

Deprecations

The information about a certain deprecation in the library also includes the version when the breaking change will happen as well as code examples for the usage before and after the deprecation.

This snippets are presented as highlited text in the migration timeline and also open up the code in StackBlitz. To provide maintainable code examples we can use version range specifier to let StackBlitz automatically install new versions until the version of the breaking change.

How to maintain the MigrationTimeLine

Workflow

Lets say we want to deprecate the resultSelector of the operator generate: https://github.com/ReactiveX/rxjs/blob/6.5.3/src/internal/observable/generate.ts#L68

Automated Crawling of Deprecations

Docs

https://hackmd.io/@mhevery/BkDUxaW84/https%3A%2F%2Fhackmd.io%2Fc%2FBkDUxaW84%2Fedit%3Fedit?type=book

Issues

PRs/ Examples

https://github.com/angular/angular/pull/30533/files#diff-9d549aa403494fd043a146b8db64f503R264-R275

Decision on message format in the deprecation documentation in code

As we need to decide on the message format (i.e. It's important if we focus on linter or docs), I create a component that lets you test the message in many different places.

Reactive Angular Terminology

To have a common terminology I list some of the used terms here and explain their meaning and usage.

Used terms:

Asynchronous/Observable Primitive
Reactive Primitives
Primitive Reactive Problems
Bind
Connect

Reactive Forms

In this section we will learn the basics of reactive forms in angular. We will learn how to set reactive forms up, use built-in validators and display validation errors.

Before we start there are some things to know. Ractive forms are fully functional without any HTML. All of the form depending logic is placed in the conponent as code and not in the template. This make our html very easy to read and edit. We can move parts of the HTML without break form related logic.

Confusing

( and ) count as frame

describe('`(` and `)`', () =>  {
  let testScheduler: TestScheduler;

  beforeEach(() => {
    testScheduler = new TestScheduler(observableMatcher);
  });

	.config('myEvents', function() {
	valueChanged : 'valueChanged'
	});

	.service('myChannel', function($rootScope, myEvents) {

	var publishValueChanged = function (newVlaue) {
	var args = {value: newVlaue};
	$rootScope.$emit(myEvents.valueChanged, args);
	};

	import * as fs from 'fs-extra';
	import * as path from 'path';
	import { bindNodeCallback, concat, Observable, from } from 'rxjs';
	import { map } from 'rxjs/operators';

	export function globCopy(
	patterns: string[],
	dir: string
	): Observable<{patterns: string[], num: number}> {
	return bindNodeCallback(copy)(patterns, dir)

	# <MEASUREMENT_NAME>

	<!-- TLDR_START -->
	<!-- TLDR_END -->

	<!-- CODE_VERSIONING_START -->
	<!-- CODE_VERSIONING_END -->

	## URL