mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
c024574f46
This commits adds `makeStateKey`, `StateKey` and `TransferState` methods in `@angular/core` as public API and deprecated the same exported symbols in `@angular/platform-browser`.
DEPRECATED: `makeStateKey`, `StateKey` and `TransferState` exports have been moved from `@angular/platform-browser` to `@angular/core`. Please update the imports.
```diff
- import {makeStateKey, StateKey, TransferState} from '@angular/platform-browser';
+ import {makeStateKey, StateKey, TransferState} from '@angular/core';
```
PR Close #49563
58 lines
2.1 KiB
TypeScript
58 lines
2.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.io/license
|
|
*/
|
|
|
|
import {DOCUMENT} from '@angular/common';
|
|
import {APP_ID, NgModule, Provider, TransferState, ɵescapeTransferStateContent as escapeTransferStateContent} from '@angular/core';
|
|
|
|
import {BEFORE_APP_SERIALIZED} from './tokens';
|
|
|
|
export const TRANSFER_STATE_SERIALIZATION_PROVIDERS: Provider[] = [{
|
|
provide: BEFORE_APP_SERIALIZED,
|
|
useFactory: serializeTransferStateFactory,
|
|
deps: [DOCUMENT, APP_ID, TransferState],
|
|
multi: true,
|
|
}];
|
|
|
|
function serializeTransferStateFactory(doc: Document, appId: string, transferStore: TransferState) {
|
|
return () => {
|
|
// The `.toJSON` here causes the `onSerialize` callbacks to be called.
|
|
// These callbacks can be used to provide the value for a given key.
|
|
const content = transferStore.toJson();
|
|
|
|
if (transferStore.isEmpty) {
|
|
// The state is empty, nothing to transfer,
|
|
// avoid creating an extra `<script>` tag in this case.
|
|
return;
|
|
}
|
|
|
|
const script = doc.createElement('script');
|
|
script.id = appId + '-state';
|
|
script.setAttribute('type', 'application/json');
|
|
script.textContent = escapeTransferStateContent(content);
|
|
|
|
// It is intentional that we add the script at the very bottom. Angular CLI script tags for
|
|
// bundles are always `type="module"`. These are deferred by default and cause the transfer
|
|
// transfer data to be queried only after the browser has finished parsing the DOM.
|
|
doc.body.appendChild(script);
|
|
};
|
|
}
|
|
|
|
/**
|
|
* NgModule to install on the server side while using the `TransferState` to transfer state from
|
|
* server to client.
|
|
*
|
|
* Note: this module is not needed if the `renderApplication` function is used.
|
|
* The `renderApplication` makes all providers from this module available in the application.
|
|
*
|
|
* @publicApi
|
|
* @deprecated no longer needed, you can inject the `TransferState` in an app without providing
|
|
* this module.
|
|
*/
|
|
@NgModule({})
|
|
export class ServerTransferStateModule {
|
|
}
|