@davidlj95/ngx-meta
Version:
Set your Angular site's metadata: standard meta tags, Open Graph, Twitter Cards, JSON-LD structured data and more. Supports SSR (and Angular Universal). Use a service. Use routes' data. Set it up in a flash! 🚀
48 lines • 4.64 kB
JavaScript
import { coreFeature, } from '../providers/core-feature';
import { provideDefaultUrlResolver } from './default-url-resolver';
/**
* Provides a base URL to enable resolving relative URLs. Including relative
* URLs provided by Angular's router.
*
* Metadata values requiring absolute URLs may accept relative URLs then.
* Internally, the library will turn the relative URL into an absolute URL
* using the base URL as prefix.
*
* The special value {@link ANGULAR_ROUTER_URL} can be used to query the
* Angular's router URL to be used as relative URL. Which with the feature
* enabled will be resolved into an absolute URL. Do not use the value if the
* feature isn't enabled. Otherwise, an invalid URL may end up used as
* metadata value.
*
* @example
*
* <b>Using standalone, recommended API</b>
* ```typescript
* provideNgxMetaCore(
* withNgxMetaBaseUrl('https://example.com')
* )
* ```
*
* <b>Using module-based API</b>
* ```typescript
* NgxMetaCoreModule.forRoot(
* withNgxMetaBaseUrl('https://example.com')
* )
* ```
*
* See also:
*
* - {@link provideNgxMetaCore}: to use it with the standalone, recommended API.
*
* - {@link NgxMetaCoreModule.(forRoot:1)}: to use it with the module-based API.
*
* - {@link https://ngx-meta.dev/guides/url-resolution/ | URL resolution guide}
*
*
* @param baseUrl - Prefix URL to use when relative URLs are used in metadata
* values where an absolute URL is preferred or required.
*
* @public
*/
export const withNgxMetaBaseUrl = (baseUrl) => coreFeature(1 /* CoreFeatureKind.BaseUrl */, [provideDefaultUrlResolver(baseUrl)]);
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2l0aC1uZ3gtbWV0YS1iYXNlLXVybC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9jb3JlL3NyYy91cmwtcmVzb2x1dGlvbi93aXRoLW5neC1tZXRhLWJhc2UtdXJsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFDTCxXQUFXLEdBR1osTUFBTSwyQkFBMkIsQ0FBQTtBQUNsQyxPQUFPLEVBQUUseUJBQXlCLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQTtBQUVsRTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQTJDRztBQUNILE1BQU0sQ0FBQyxNQUFNLGtCQUFrQixHQUFHLENBQ2hDLE9BQWdCLEVBQ3NCLEVBQUUsQ0FDeEMsV0FBVyxrQ0FBMEIsQ0FBQyx5QkFBeUIsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUEiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBCYXNlVXJsIH0gZnJvbSAnLi9iYXNlLXVybCdcbmltcG9ydCB7XG4gIGNvcmVGZWF0dXJlLFxuICBDb3JlRmVhdHVyZSxcbiAgQ29yZUZlYXR1cmVLaW5kLFxufSBmcm9tICcuLi9wcm92aWRlcnMvY29yZS1mZWF0dXJlJ1xuaW1wb3J0IHsgcHJvdmlkZURlZmF1bHRVcmxSZXNvbHZlciB9IGZyb20gJy4vZGVmYXVsdC11cmwtcmVzb2x2ZXInXG5cbi8qKlxuICogUHJvdmlkZXMgYSBiYXNlIFVSTCB0byBlbmFibGUgcmVzb2x2aW5nIHJlbGF0aXZlIFVSTHMuIEluY2x1ZGluZyByZWxhdGl2ZVxuICogVVJMcyBwcm92aWRlZCBieSBBbmd1bGFyJ3Mgcm91dGVyLlxuICpcbiAqIE1ldGFkYXRhIHZhbHVlcyByZXF1aXJpbmcgYWJzb2x1dGUgVVJMcyBtYXkgYWNjZXB0IHJlbGF0aXZlIFVSTHMgdGhlbi5cbiAqIEludGVybmFsbHksIHRoZSBsaWJyYXJ5IHdpbGwgdHVybiB0aGUgcmVsYXRpdmUgVVJMIGludG8gYW4gYWJzb2x1dGUgVVJMXG4gKiB1c2luZyB0aGUgYmFzZSBVUkwgYXMgcHJlZml4LlxuICpcbiAqIFRoZSBzcGVjaWFsIHZhbHVlIHtAbGluayBBTkdVTEFSX1JPVVRFUl9VUkx9IGNhbiBiZSB1c2VkIHRvIHF1ZXJ5IHRoZVxuICogQW5ndWxhcidzIHJvdXRlciBVUkwgdG8gYmUgdXNlZCBhcyByZWxhdGl2ZSBVUkwuIFdoaWNoIHdpdGggdGhlIGZlYXR1cmVcbiAqIGVuYWJsZWQgd2lsbCBiZSByZXNvbHZlZCBpbnRvIGFuIGFic29sdXRlIFVSTC4gRG8gbm90IHVzZSB0aGUgdmFsdWUgaWYgdGhlXG4gKiBmZWF0dXJlIGlzbid0IGVuYWJsZWQuIE90aGVyd2lzZSwgYW4gaW52YWxpZCBVUkwgbWF5IGVuZCB1cCB1c2VkIGFzXG4gKiBtZXRhZGF0YSB2YWx1ZS5cbiAqXG4gKiBAZXhhbXBsZVxuICpcbiAqIDxiPlVzaW5nIHN0YW5kYWxvbmUsIHJlY29tbWVuZGVkIEFQSTwvYj5cbiAqIGBgYHR5cGVzY3JpcHRcbiAqIHByb3ZpZGVOZ3hNZXRhQ29yZShcbiAqICAgd2l0aE5neE1ldGFCYXNlVXJsKCdodHRwczovL2V4YW1wbGUuY29tJylcbiAqIClcbiAqIGBgYFxuICpcbiAqIDxiPlVzaW5nIG1vZHVsZS1iYXNlZCBBUEk8L2I+XG4gKiBgYGB0eXBlc2NyaXB0XG4gKiBOZ3hNZXRhQ29yZU1vZHVsZS5mb3JSb290KFxuICogICB3aXRoTmd4TWV0YUJhc2VVcmwoJ2h0dHBzOi8vZXhhbXBsZS5jb20nKVxuICogKVxuICogYGBgXG4gKlxuICogU2VlIGFsc286XG4gKlxuICogLSB7QGxpbmsgcHJvdmlkZU5neE1ldGFDb3JlfTogdG8gdXNlIGl0IHdpdGggdGhlIHN0YW5kYWxvbmUsIHJlY29tbWVuZGVkIEFQSS5cbiAqXG4gKiAtIHtAbGluayBOZ3hNZXRhQ29yZU1vZHVsZS4oZm9yUm9vdDoxKX06IHRvIHVzZSBpdCB3aXRoIHRoZSBtb2R1bGUtYmFzZWQgQVBJLlxuICpcbiAqIC0ge0BsaW5rIGh0dHBzOi8vbmd4LW1ldGEuZGV2L2d1aWRlcy91cmwtcmVzb2x1dGlvbi8gfCBVUkwgcmVzb2x1dGlvbiBndWlkZX1cbiAqXG4gKlxuICogQHBhcmFtIGJhc2VVcmwgLSBQcmVmaXggVVJMIHRvIHVzZSB3aGVuIHJlbGF0aXZlIFVSTHMgYXJlIHVzZWQgaW4gbWV0YWRhdGFcbiAqIHZhbHVlcyB3aGVyZSBhbiBhYnNvbHV0ZSBVUkwgaXMgcHJlZmVycmVkIG9yIHJlcXVpcmVkLlxuICpcbiAqIEBwdWJsaWNcbiAqL1xuZXhwb3J0IGNvbnN0IHdpdGhOZ3hNZXRhQmFzZVVybCA9IChcbiAgYmFzZVVybDogQmFzZVVybCxcbik6IENvcmVGZWF0dXJlPENvcmVGZWF0dXJlS2luZC5CYXNlVXJsPiA9PlxuICBjb3JlRmVhdHVyZShDb3JlRmVhdHVyZUtpbmQuQmFzZVVybCwgW3Byb3ZpZGVEZWZhdWx0VXJsUmVzb2x2ZXIoYmFzZVVybCldKVxuIl19